diff --git a/yaml/server-api-24r1.json b/yaml/server-api-24r1.json
new file mode 100644
index 00000000..7ae1e1c7
--- /dev/null
+++ b/yaml/server-api-24r1.json
@@ -0,0 +1,38498 @@
+{
+ "openapi": "3.0.1",
+ "info": {
+ "title": "MI Server API",
+ "version": "v1"
+ },
+ "paths": {
+ "/v1alpha/databases/{database-key}/tables/{table-identity}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the table.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "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/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"7294a924-292c-468a-a9e7-377147af7a4a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"d60695a1-37f8-4dcc-a8ba-cb517991f84d","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"15deb2b6-3acd-48d3-bf41-ac1ea427b8a8","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"7294a924-292c-468a-a9e7-377147af7a4a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"d60695a1-37f8-4dcc-a8ba-cb517991f84d","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"15deb2b6-3acd-48d3-bf41-ac1ea427b8a8","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"7294a924-292c-468a-a9e7-377147af7a4a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"d60695a1-37f8-4dcc-a8ba-cb517991f84d","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"15deb2b6-3acd-48d3-bf41-ac1ea427b8a8","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"7294a924-292c-468a-a9e7-377147af7a4a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"d60695a1-37f8-4dcc-a8ba-cb517991f84d","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"15deb2b6-3acd-48d3-bf41-ac1ea427b8a8","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the table.",
+ "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/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"df6f8ae1-b66d-4753-9b2b-c951b1a8bf22","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"0655aec7-159f-4a5b-bebc-25d5a897e136","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ee89e844-ff66-4e3f-8824-430e7ac4b130","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"df6f8ae1-b66d-4753-9b2b-c951b1a8bf22","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"0655aec7-159f-4a5b-bebc-25d5a897e136","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ee89e844-ff66-4e3f-8824-430e7ac4b130","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"df6f8ae1-b66d-4753-9b2b-c951b1a8bf22","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"0655aec7-159f-4a5b-bebc-25d5a897e136","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ee89e844-ff66-4e3f-8824-430e7ac4b130","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"df6f8ae1-b66d-4753-9b2b-c951b1a8bf22","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"0655aec7-159f-4a5b-bebc-25d5a897e136","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ee89e844-ff66-4e3f-8824-430e7ac4b130","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the database.",
+ "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/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"4fbbfc65-25a4-444c-8636-844cc3fd30af","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"60d3efba-9e92-4b9d-8b79-107ae9afb913","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"c581a4e3-b67c-4d0d-8a47-328575be2cd4","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"4fbbfc65-25a4-444c-8636-844cc3fd30af","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"60d3efba-9e92-4b9d-8b79-107ae9afb913","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"c581a4e3-b67c-4d0d-8a47-328575be2cd4","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"4fbbfc65-25a4-444c-8636-844cc3fd30af","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"60d3efba-9e92-4b9d-8b79-107ae9afb913","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"c581a4e3-b67c-4d0d-8a47-328575be2cd4","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"4fbbfc65-25a4-444c-8636-844cc3fd30af","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"60d3efba-9e92-4b9d-8b79-107ae9afb913","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"c581a4e3-b67c-4d0d-8a47-328575be2cd4","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the integration schema.",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"e931da60-e821-4e91-b678-2f46240f3bd6","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"9527bcf0-fbd0-4fba-95a8-40055c581b13","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"50849230-28c2-4b26-a4a0-b21e7d22bd7d","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"e931da60-e821-4e91-b678-2f46240f3bd6","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"9527bcf0-fbd0-4fba-95a8-40055c581b13","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"50849230-28c2-4b26-a4a0-b21e7d22bd7d","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"e931da60-e821-4e91-b678-2f46240f3bd6","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"9527bcf0-fbd0-4fba-95a8-40055c581b13","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"50849230-28c2-4b26-a4a0-b21e7d22bd7d","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"e931da60-e821-4e91-b678-2f46240f3bd6","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"9527bcf0-fbd0-4fba-95a8-40055c581b13","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"50849230-28c2-4b26-a4a0-b21e7d22bd7d","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:search-index-status": {
+ "get": {
+ "tags": [
+ "Database"
+ ],
+ "summary": "Get Search Index Status for a given database",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "include-diagnostics",
+ "in": "query",
+ "description": "",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchIndexStatus"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchIndexStatus"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchIndexStatus"
+ }
+ }
+ }
+ },
+ "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": [
+ "Database"
+ ],
+ "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-name",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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.",
+ "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-identity",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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.",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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.",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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.",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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.",
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:export": {
+ "post": {
+ "tags": [
+ "DataExport"
+ ],
+ "summary": "Export data from the given database.",
+ "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/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:export": {
+ "post": {
+ "tags": [
+ "DataExport"
+ ],
+ "summary": "Export data from the integration schema.",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Lists the available integration schemas.",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created successfully",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Schema not specified"
+ },
+ "403": {
+ "description": "Forbidden. User is not a global administrator or an administrator for the schema"
+ },
+ "422": {
+ "description": "Invalid schema. Returns a list of validation errors"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:search-index-status": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "include-diagnostics",
+ "in": "query",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas:search-index-status": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Returns the status of all available integration schemas.",
+ "parameters": [
+ {
+ "name": "include-diagnostics",
+ "in": "query",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}": {
+ "put": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Updates an integration schema, or adds a new one if there is not one with the same key already.\r\nWill fail if the schema is not valid, or if the user is not both a global administrator and an administrator for the schema.",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Updated successfully",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Schema not specified"
+ },
+ "403": {
+ "description": "Forbidden. User is not a global administrator or an administrator for the schema"
+ },
+ "422": {
+ "description": "Invalid schema. Returns a list of validation errors"
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "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.",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}/attributes": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Returns a list of the attributes defined in the integration schema.",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}/sources/database/{database-key}/table/{table-identity}": {
+ "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.",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/job-queue/jobs": {
+ "get": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Get a list of jobs.",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsGetJobsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsGetJobsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsGetJobsResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Create a new job.",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created successfully"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Delete specified jobs.",
+ "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": "Success",
+ "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.",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Job not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Update a job.",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Job not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Delete a job.",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ }
+ }
+ },
+ "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).",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "404": {
+ "description": "Job not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/job-queue/jobs/{id}:resubmit": {
+ "post": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Resubmit a job.",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ },
+ "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.",
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ContentType": {
+ "type": "string"
+ },
+ "ContentDisposition": {
+ "type": "string"
+ },
+ "Headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "Length": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "Name": {
+ "type": "string"
+ },
+ "FileName": {
+ "type": "string"
+ }
+ }
+ },
+ "encoding": {
+ "ContentType": {
+ "style": "form"
+ },
+ "ContentDisposition": {
+ "style": "form"
+ },
+ "Headers": {
+ "style": "form"
+ },
+ "Length": {
+ "style": "form"
+ },
+ "Name": {
+ "style": "form"
+ },
+ "FileName": {
+ "style": "form"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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.",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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.",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "fileName",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/SystemIOStream"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SystemIOStream"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SystemIOStream"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Job or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/job-queue/processing-configuration": {
+ "get": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Get the processing configuration.",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsProcessingConfig"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsProcessingConfig"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsProcessingConfig"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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.",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/lists/list/{listIdentifier}/items": {
+ "get": {
+ "tags": [
+ "ListItem"
+ ],
+ "summary": "Returns the items in the given list",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ }
+ }
+ }
+ },
+ "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",
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "ListManagement"
+ ],
+ "summary": "Creates a new list with the specified properties and items.",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListCreate"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListCreate"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListCreate"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListCreate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchInfo"
+ }
+ }
+ }
+ },
+ "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",
+ "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/GrantaServerApiListsDtoRecordListSearchResult"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchResult"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchResult"
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list not found"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ListManagement"
+ ],
+ "summary": "If the list exists, updates the properties of the list. This will overwrite all current properties, but not the contents of the list.\r\nIf the list does not exist, returns '404 not found' response",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListProperties"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListProperties"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListProperties"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListProperties"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ListManagement"
+ ],
+ "summary": "Performs a partial update on the properties of a list. Only replace operations on name, description or notes are supported.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/JsonPatchDocument"
+ }
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": [{"value":"new name","path":"/name","op":"replace"}]
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/JsonPatchDocument"
+ }
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": [{"value":"new name","path":"/name","op":"replace"}]
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/JsonPatchDocument"
+ }
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": [{"value":"new name","path":"/name","op":"replace"}]
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/JsonPatchDocument"
+ }
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": [{"value":"new name","path":"/name","op":"replace"}]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ListManagement"
+ ],
+ "summary": "Delete an existing list.",
+ "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\".",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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\".",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list not found"
+ }
+ }
+ }
+ },
+ "/api/v1/lists/list/{listIdentifier}/permissions": {
+ "get": {
+ "tags": [
+ "ListPermissions"
+ ],
+ "summary": "Gets all permissions associated with the specified list.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionInputDto"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionInputDto"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionInputDto"
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionInputDto"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionDto"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list or user or group not found"
+ }
+ }
+ }
+ },
+ "/api/v1/lists/list/{listIdentifier}/permissions/user/{userIdentifier}": {
+ "get": {
+ "tags": [
+ "ListPermissions"
+ ],
+ "summary": "Gets the permission flags of the permission associating the specified list with the specified user.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "userIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "userIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list or user or 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.",
+ "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": "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/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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":"Alumino silicate - 1720","guid":"00000026-000e-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.",
+ "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": "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/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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":"Alumino silicate - 1720","guid":"00000026-000e-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/{record-history-guid}/record-versions/{record-version-guid}": {
+ "get": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "summary": "Get a record version with a specified guid for a given database, table and record history.",
+ "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": "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/GrantaServerApiRecordsRecordVersionsRecordVersion"
+ },
+ "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Alumino silicate - 1720","recordColor":"fuchsia","versionNumber":1,"versionState":"unversioned","name":"Alumino silicate - 1720","guid":"00000026-000e-4fff-8fff-dd92ffff0000"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table, record history or record version not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/schema/mi-version": {
+ "get": {
+ "tags": [
+ "Schema"
+ ],
+ "summary": "Returns the currently running MI version to the caller.",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAdminMiVersion"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get all attributes in table",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Create a new attribute.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"74d151b6-24c4-47a5-8753-a15b426c8ad7"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"74d151b6-24c4-47a5-8753-a15b426c8ad7"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"74d151b6-24c4-47a5-8753-a15b426c8ad7"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"74d151b6-24c4-47a5-8753-a15b426c8ad7"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"discrete","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":[]},"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": {"type":"range","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":[{"name":"Tensile strength [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":"7cab88a9-8198-48f4-aa73-e3f5cd2f6967"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"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 table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get attribute in table",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"discrete","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":[]},"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": {"type":"range","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":[{"name":"Tensile strength [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":"23901e0f-2b24-4b95-9e08-9d308263d0d7"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"displayNames":{},"name":"Restricted substances associated with this material","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Update attribute.",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "examples": {
+ "Example 29": {
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{"fr":"Casting Date French Display Name"},"name":"Casting Date","guid":"fe9cbde6-756a-4b1d-a347-7d49e56ee90f"}
+ },
+ "Example 30": {
+ "summary": "Discrete attribute",
+ "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"discrete","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":[]},"displayNames":{},"name":"Metals","guid":"0000000b-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 31": {
+ "summary": "Range attribute",
+ "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"range","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":[{"name":"Tensile strength [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":"9d5cc4cc-3b4a-482b-84fc-c2932053bf9b"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 32": {
+ "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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"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 or attribute not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Delete an attribute.",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request. Attribute in use.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsAttributeDeletionException"
+ },
+ "example": {"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":"InUse","referencedByType":"VersionControlledData"},{"message":"It is being used in one or more expressions.","reason":"InUse","referencedByType":"Expression","referencedBy":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}]}
+ }
+ }
+ },
+ "200": {
+ "description": "Ok"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get all meta-attributes in table",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get meta-attribute in table",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"discrete","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":[]},"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": {"type":"range","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":[{"name":"Tensile strength [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":"b8b8dc47-66d7-47fe-89eb-1393e33f4831"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"displayNames":{},"name":"Restricted substances associated with this material","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or meta-attribute not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Update meta-attribute.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "examples": {
+ "Example 37": {
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{"fr":"Casting Date French Display Name"},"name":"Casting Date","guid":"fe9cbde6-756a-4b1d-a347-7d49e56ee90f"}
+ },
+ "Example 38": {
+ "summary": "Discrete attribute",
+ "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"discrete","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":[]},"displayNames":{},"name":"Metals","guid":"0000000b-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 39": {
+ "summary": "Range attribute",
+ "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"range","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":[{"name":"Tensile strength [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":"acda8b3a-0949-4694-b11b-9eb08106fd30"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 40": {
+ "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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"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 or meta-attribute not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Delete a meta-attribute.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsAttributeDeletionException"
+ },
+ "example": {"message":"Cannot delete attribute 'Notes' (GUID = 'e5cd7874-4824-4e92-8c87-1d5c7f0e1c4d').","code":400,"errors":[{"message":"It is being used in version controlled data.","reason":"InUse","referencedByType":"VersionControlledData"},{"message":"It is being used in one or more search masks.","reason":"InUse","referencedByType":"SearchMask","referencedBy":[{"name":"Search mask that searches in Notes","guid":"65174f0b-b2fa-467f-8b78-e71f88c75dda"}]}]}
+ }
+ }
+ },
+ "200": {
+ "description": "OK"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or meta-attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get meta-attributes for attribute",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}:validate": {
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Validates the provided value against the attributes data rules.",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeValidateResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}:validate": {
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Validates the provided value against the meta attributes data rules.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeValidateResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or meta-attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/configurations/{configuration-type}": {
+ "get": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Get all configurations of given type",
+ "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"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfigurationsInfo"
+ },
+ "example": {"configurations":[{"name":"examples","guid":"997e8f58-bd2a-494f-9a99-18b3d395ad0a"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Create a new configuration.",
+ "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"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"e302de7b-facf-42bb-8442-33503e9f0c7c"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"e302de7b-facf-42bb-8442-33503e9f0c7c"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"e302de7b-facf-42bb-8442-33503e9f0c7c"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"e302de7b-facf-42bb-8442-33503e9f0c7c"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfiguration"
+ },
+ "example": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples","guid":"997e8f58-bd2a-494f-9a99-18b3d395ad0a"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Get individual configuration",
+ "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"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "configuration-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfiguration"
+ },
+ "example": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples","guid":"997e8f58-bd2a-494f-9a99-18b3d395ad0a"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or configuration not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Update a configuration.",
+ "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"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "configuration-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"498f0f5b-3019-4f0a-8d18-9618af9e9b1a"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"498f0f5b-3019-4f0a-8d18-9618af9e9b1a"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"498f0f5b-3019-4f0a-8d18-9618af9e9b1a"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"498f0f5b-3019-4f0a-8d18-9618af9e9b1a"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfiguration"
+ },
+ "example": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","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",
+ "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"
+ ],
+ "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",
+ "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"
+ ],
+ "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",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsConstantsInfo"
+ },
+ "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.",
+ "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/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"c70ece52-b63b-4276-ad66-70993d1519aa"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum (guid and unit)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"c70ece52-b63b-4276-ad66-70993d1519aa"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum (guid and unit)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"c70ece52-b63b-4276-ad66-70993d1519aa"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum (guid and unit)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"c70ece52-b63b-4276-ad66-70993d1519aa"}
+ },
+ "Example 6": {
+ "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": {"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/GrantaServerApiSchemaConstantsConstant"
+ },
+ "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 not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/constants/{constant-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Constants"
+ ],
+ "summary": "Get individual constant",
+ "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/GrantaServerApiSchemaConstantsConstant"
+ },
+ "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.",
+ "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/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"ccb5b575-34fc-4f96-8942-84cd2a2e9b25"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"87893c9c-75d2-4d41-84c3-aaff1da95cf2"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"ccb5b575-34fc-4f96-8942-84cd2a2e9b25"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"87893c9c-75d2-4d41-84c3-aaff1da95cf2"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"ccb5b575-34fc-4f96-8942-84cd2a2e9b25"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"87893c9c-75d2-4d41-84c3-aaff1da95cf2"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"ccb5b575-34fc-4f96-8942-84cd2a2e9b25"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"87893c9c-75d2-4d41-84c3-aaff1da95cf2"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsConstant"
+ },
+ "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",
+ "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/GrantaServerApiExceptionsConstantDeletionException"
+ },
+ "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":"InUse","referencedByType":"Expression","referencedBy":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}]}
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRulesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Create a new data rule",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/data-rules/{data-rule-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Gets a data rule for a given database and guid.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "data-rule-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or data rule not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Edit a data rule",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "data-rule-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or data rule name not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Delete a data rule.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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."
+ }
+ }
+ }
+ },
+ "/v1alpha/databases": {
+ "get": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Lists all databases that the user can see.",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabasesInfo"
+ },
+ "example": {"databases":[{"key":"MI_Training","versionGuid":"feead34a-cc0e-4070-bbc0-647654a25407","status":"OK","isReadOnly":false,"isLocked":false,"indexInSync":true,"schemaVersion":"2022.08.18.01","name":"MI Training","guid":"43a43640-4919-428a-bac9-16efbc4ce6ed"}]}
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}": {
+ "get": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Returns details for a given database.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Update database details.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"ec029ad5-7995-4f35-8c92-60f6ca4383ac","name":"MI Training (Updated)","guid":"242b4c56-4330-4faa-b5c4-2cb65633af40"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"ec029ad5-7995-4f35-8c92-60f6ca4383ac","name":"MI Training (Updated)","guid":"242b4c56-4330-4faa-b5c4-2cb65633af40"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"ec029ad5-7995-4f35-8c92-60f6ca4383ac","name":"MI Training (Updated)","guid":"242b4c56-4330-4faa-b5c4-2cb65633af40"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"ec029ad5-7995-4f35-8c92-60f6ca4383ac","name":"MI Training (Updated)","guid":"242b4c56-4330-4faa-b5c4-2cb65633af40"}
+ },
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database not found."
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:lock": {
+ "post": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Lock database",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "Database to lock",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database not found."
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:unlock": {
+ "post": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Unlock database",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "Database to unlock",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteTypesInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Discrete Types"
+ ],
+ "summary": "Create a new discrete type.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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.",
+ "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/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or discrete type not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Discrete Types"
+ ],
+ "summary": "Update discrete type.",
+ "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/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database or discrete type not found."
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Discrete Types"
+ ],
+ "summary": "Delete discrete type, including all of its discrete values.",
+ "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": {
+ "400": {
+ "description": "Bad request. Discrete type in use by Attributes.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDiscreteTypeDeletionException"
+ },
+ "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":"InUse","referencedByType":"Attribute","referencedBy":[{"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.",
+ "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/GrantaServerApiSchemaSlimEntitiesSlimObjects"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "404": {
+ "description": "Database or discrete type 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. If discreteType is ordered, then discreteValues will be return in order, otherwise order is not deterministic.",
+ "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/GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or discrete type not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - DiscreteTypes - DiscreteValues"
+ ],
+ "summary": "Create new discrete value. If it's ordered, it will be added at the end.",
+ "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/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"bdd1694d-f161-42a3-945a-306db70b6769"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"bdd1694d-f161-42a3-945a-306db70b6769"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"bdd1694d-f161-42a3-945a-306db70b6769"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"bdd1694d-f161-42a3-945a-306db70b6769"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ },
+ "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.",
+ "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/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or discrete type not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values/{discrete-value-guid}": {
+ "get": {
+ "tags": [
+ "Schema - DiscreteTypes - DiscreteValues"
+ ],
+ "summary": "Gets specific discrete value for a given discreteType within a given database.",
+ "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": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, discrete type or discrete value not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - DiscreteTypes - DiscreteValues"
+ ],
+ "summary": "Update discrete value.",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ },
+ "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.",
+ "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/GrantaServerApiExceptionsDiscreteValueDeletionException"
+ },
+ "example": {"message":"Cannot delete discrete value 'Unacceptable' (GUID = '00000583-0007-4fff-8fff-0083ffff0000').","code":400,"errors":[{"message":"It is being used in one or more data items.","reason":"InUse","referencedByType":"Data"}]}
+ }
+ }
+ },
+ "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",
+ "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/GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "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",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/exporters/{folder-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Get Exporters Folder",
+ "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/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","name":"Abaqus","guid":"41aba877-8fe0-4295-bddb-6f8b270a40ff"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","name":"Abaqus","guid":"41aba877-8fe0-4295-bddb-6f8b270a40ff"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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.",
+ "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/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"ae27162f-3cc0-4543-a442-e8e58d055a1a"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"ae27162f-3cc0-4543-a442-e8e58d055a1a"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"ae27162f-3cc0-4543-a442-e8e58d055a1a"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"ae27162f-3cc0-4543-a442-e8e58d055a1a"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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.",
+ "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",
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"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 or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/exporters:re-fetch": {
+ "post": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Re-fetch the Exporter Files.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesExporterRefetchInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesExporterRefetchInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesExporterRefetchInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/exporters/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Move an existing Exporter Folder.",
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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",
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"9ef18bfe-8a07-45f8-9cd6-25c9e9fd3524"},{"name":"no-transform.xslt","guid":"158552ea-a522-4e2b-aa41-e4e0ead3314a"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"9ef18bfe-8a07-45f8-9cd6-25c9e9fd3524"},{"name":"no-transform.xslt","guid":"158552ea-a522-4e2b-aa41-e4e0ead3314a"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"9ef18bfe-8a07-45f8-9cd6-25c9e9fd3524"},{"name":"no-transform.xslt","guid":"158552ea-a522-4e2b-aa41-e4e0ead3314a"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Create a new Exporter File.",
+ "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": {
+ "ContentType": {
+ "type": "string"
+ },
+ "ContentDisposition": {
+ "type": "string"
+ },
+ "Headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "Length": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "Name": {
+ "type": "string"
+ },
+ "FileName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "encoding": {
+ "ContentType": {
+ "style": "form"
+ },
+ "ContentDisposition": {
+ "style": "form"
+ },
+ "Headers": {
+ "style": "form"
+ },
+ "Length": {
+ "style": "form"
+ },
+ "Name": {
+ "style": "form"
+ },
+ "FileName": {
+ "style": "form"
+ },
+ "description": {
+ "style": "form"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"86ee7682-bd3e-47b8-a535-ad3bbcc92c2d"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"86ee7682-bd3e-47b8-a535-ad3bbcc92c2d"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"86ee7682-bd3e-47b8-a535-ad3bbcc92c2d"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"0c882b91-a01c-4873-95fa-84adf71d1a1a"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"0c882b91-a01c-4873-95fa-84adf71d1a1a"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"0c882b91-a01c-4873-95fa-84adf71d1a1a"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Update an existing Exporter File.",
+ "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/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"13643e7b-20b7-4f01-8c37-ef92fd2606a9"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"13643e7b-20b7-4f01-8c37-ef92fd2606a9"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"13643e7b-20b7-4f01-8c37-ef92fd2606a9"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"13643e7b-20b7-4f01-8c37-ef92fd2606a9"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"3460818b-cefd-45b1-b271-740cf2d9e720"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"3460818b-cefd-45b1-b271-740cf2d9e720"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"3460818b-cefd-45b1-b271-740cf2d9e720"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Delete an Exporter File.",
+ "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"
+ },
+ "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",
+ "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"
+ },
+ "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.",
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"5924916c-7e1a-4127-974c-7d3d65b95618"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"5924916c-7e1a-4127-974c-7d3d65b95618"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"5924916c-7e1a-4127-974c-7d3d65b95618"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions": {
+ "get": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Get all expressions for table",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpressionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Create a new expression.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"aadd5ebc-1a58-43b0-be3e-7dde5956e4f0"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"aadd5ebc-1a58-43b0-be3e-7dde5956e4f0"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"aadd5ebc-1a58-43b0-be3e-7dde5956e4f0"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"aadd5ebc-1a58-43b0-be3e-7dde5956e4f0"}
+ },
+ "Example 6": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpression"
+ },
+ "examples": {
+ "Example 5": {
+ "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":[{"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"name":"Fatigue strength at 10^7 cycles","guid":"0000010c-0001-4fff-8fff-dd92ffff0000"},{"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"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"}
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Get an expression with a specified guid for a given database and table.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "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": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpression"
+ },
+ "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":[{"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"name":"Fatigue strength at 10^7 cycles","guid":"0000010c-0001-4fff-8fff-dd92ffff0000"},{"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"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"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or expression not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Update an expression.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "expression-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"8bb29cea-d7d2-4942-bce2-716ca17d9615"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"8bb29cea-d7d2-4942-bce2-716ca17d9615"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"8bb29cea-d7d2-4942-bce2-716ca17d9615"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"8bb29cea-d7d2-4942-bce2-716ca17d9615"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpression"
+ },
+ "examples": {
+ "Example 6": {
+ "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":[{"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"name":"Fatigue strength at 10^7 cycles","guid":"0000010c-0001-4fff-8fff-dd92ffff0000"},{"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"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"}
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or expression not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Delete an expression.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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/databases/{database-key}/help-folders": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get All Help File Folders",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Create a new Help File Folder.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/help-folders/:root-folder": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Root Help File Folder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Help Pages","guid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Help Pages","guid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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",
+ "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/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"html","guid":"99ff4816-15e9-42b9-9ac3-b60fce881e85"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"html","guid":"99ff4816-15e9-42b9-9ac3-b60fce881e85"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"html","guid":"99ff4816-15e9-42b9-9ac3-b60fce881e85"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Update an existing Help File Folder.",
+ "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/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"94283897-0465-4881-9f7d-fba212ba9e8f"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"94283897-0465-4881-9f7d-fba212ba9e8f"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"94283897-0465-4881-9f7d-fba212ba9e8f"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"94283897-0465-4881-9f7d-fba212ba9e8f"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Delete a Help File Folder.",
+ "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}/help-folders/{folder-guid}:child-folders": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Child Help File Folders",
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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 or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Move an existing Help File Folder.",
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/help-folders/{folder-guid}/files": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Files in a Folder",
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "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.",
+ "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": {
+ "ContentType": {
+ "type": "string"
+ },
+ "ContentDisposition": {
+ "type": "string"
+ },
+ "Headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "Length": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "Name": {
+ "type": "string"
+ },
+ "FileName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "encoding": {
+ "ContentType": {
+ "style": "form"
+ },
+ "ContentDisposition": {
+ "style": "form"
+ },
+ "Headers": {
+ "style": "form"
+ },
+ "Length": {
+ "style": "form"
+ },
+ "Name": {
+ "style": "form"
+ },
+ "FileName": {
+ "style": "form"
+ },
+ "description": {
+ "style": "form"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"a7266892-9b3e-4f58-a08a-4b414e578446"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"a7266892-9b3e-4f58-a08a-4b414e578446"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"a7266892-9b3e-4f58-a08a-4b414e578446"}
+ }
+ }
+ },
+ "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",
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "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 - Help Files"
+ ],
+ "summary": "Update an existing Help File.",
+ "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/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"bf987be1-3b26-478c-844b-4e8f149f8b07"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"bf987be1-3b26-478c-844b-4e8f149f8b07"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"bf987be1-3b26-478c-844b-4e8f149f8b07"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"bf987be1-3b26-478c-844b-4e8f149f8b07"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"285f18c7-8cd7-4e5e-bc80-e08fcc91763c"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"285f18c7-8cd7-4e5e-bc80-e08fcc91763c"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"285f18c7-8cd7-4e5e-bc80-e08fcc91763c"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Delete a Help File.",
+ "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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file 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",
+ "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"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Move an existing Help File.",
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"320f5ebe-b4a4-4b3f-a1d1-81afc55409d1"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"320f5ebe-b4a4-4b3f-a1d1-81afc55409d1"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"320f5ebe-b4a4-4b3f-a1d1-81afc55409d1"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get All Home Page Folders",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"},{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"95363785-353a-4c05-9339-75aa77f5a80b"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"},{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"95363785-353a-4c05-9339-75aa77f5a80b"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"},{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"95363785-353a-4c05-9339-75aa77f5a80b"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Create a new Home Page Folder.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/home-page-folders:root-folder": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Root Home Page Folder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Home Page Folder",
+ "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/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"267d1cc1-dd6f-430a-8ccd-437112db1497"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"267d1cc1-dd6f-430a-8ccd-437112db1497"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"267d1cc1-dd6f-430a-8ccd-437112db1497"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Update an existing Home Page Folder.",
+ "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/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"9e9e45df-7fd0-4c22-b093-fd2952ec5e49"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"9e9e45df-7fd0-4c22-b093-fd2952ec5e49"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"9e9e45df-7fd0-4c22-b093-fd2952ec5e49"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"9e9e45df-7fd0-4c22-b093-fd2952ec5e49"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Delete a Home Page Folder.",
+ "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}/home-page-folders/{folder-guid}:child-folders": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Child Home Page Folders",
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"e9169173-735e-4546-82b3-3b33361c0041"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"e9169173-735e-4546-82b3-3b33361c0041"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"e9169173-735e-4546-82b3-3b33361c0041"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Move an existing Home Page Folder.",
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/home-page-folders/{folder-guid}/files": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get the Home Page Files in a Folder",
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"9fc6e533-6ca3-4f66-8a7f-226f8cc58ad1"},{"name":"home-page-2.html","guid":"41491ee7-f349-4d5a-b220-7000eb4f88cc"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"9fc6e533-6ca3-4f66-8a7f-226f8cc58ad1"},{"name":"home-page-2.html","guid":"41491ee7-f349-4d5a-b220-7000eb4f88cc"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"9fc6e533-6ca3-4f66-8a7f-226f8cc58ad1"},{"name":"home-page-2.html","guid":"41491ee7-f349-4d5a-b220-7000eb4f88cc"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Create a new Home Page File.",
+ "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": {
+ "ContentType": {
+ "type": "string"
+ },
+ "ContentDisposition": {
+ "type": "string"
+ },
+ "Headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "Length": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "Name": {
+ "type": "string"
+ },
+ "FileName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "encoding": {
+ "ContentType": {
+ "style": "form"
+ },
+ "ContentDisposition": {
+ "style": "form"
+ },
+ "Headers": {
+ "style": "form"
+ },
+ "Length": {
+ "style": "form"
+ },
+ "Name": {
+ "style": "form"
+ },
+ "FileName": {
+ "style": "form"
+ },
+ "description": {
+ "style": "form"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"083e1973-e385-4fc7-b905-b8bd1e214ea8"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"083e1973-e385-4fc7-b905-b8bd1e214ea8"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"083e1973-e385-4fc7-b905-b8bd1e214ea8"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get the header information for a Home Page File",
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c13eb185-2558-4b4a-8395-33c031663925","description":"Description of home page file.","extension":"html","dataLength":12895,"path":"HomePages","name":"home-page.html","guid":"dae7dc91-161a-4e16-869c-7f3c74bb478a"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c13eb185-2558-4b4a-8395-33c031663925","description":"Description of home page file.","extension":"html","dataLength":12895,"path":"HomePages","name":"home-page.html","guid":"dae7dc91-161a-4e16-869c-7f3c74bb478a"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c13eb185-2558-4b4a-8395-33c031663925","description":"Description of home page file.","extension":"html","dataLength":12895,"path":"HomePages","name":"home-page.html","guid":"dae7dc91-161a-4e16-869c-7f3c74bb478a"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Update an existing Home Page File.",
+ "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/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"40ce6cba-898f-4cdf-9ea3-279eba67d1a3"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"40ce6cba-898f-4cdf-9ea3-279eba67d1a3"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"40ce6cba-898f-4cdf-9ea3-279eba67d1a3"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"40ce6cba-898f-4cdf-9ea3-279eba67d1a3"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"75f3eb6d-33b7-422e-beb8-9111adc3b33e"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"75f3eb6d-33b7-422e-beb8-9111adc3b33e"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"75f3eb6d-33b7-422e-beb8-9111adc3b33e"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Delete a Home Page File.",
+ "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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:export": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Home Page File as a file",
+ "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"
+ },
+ "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.",
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"3e3f93ba-7150-407f-824f-a8c349e64317"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"3e3f93ba-7150-407f-824f-a8c349e64317"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"3e3f93ba-7150-407f-824f-a8c349e64317"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections": {
+ "get": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Get all sections for a layout",
+ "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/GrantaServerApiSchemaLayoutsLayoutSectionsInfo"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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":"532ad8ad-6d9e-405e-a54d-610672da7855","name":"Price","guid":"a4b87886-ad3d-4c50-99ab-264e0414ba61"},{"itemType":"attribute","attributeType":"point","required":false,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"0cde312c-0250-4e29-9e78-19662ad8e6c0","name":"Density","guid":"b1cfc055-6ecd-468e-8cb4-aa6ee30c3296"}],"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":"ec5a11b9-e2a0-4bd7-b2e6-81d870f1eb3a","name":"Young's modulus","guid":"abfcc8e6-49e6-49b1-938e-c801589e160f"},{"itemType":"attribute","attributeType":"range","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"64c70109-a854-43c9-bf5e-70add4f5fb47","name":"Tensile strength","guid":"7d85817e-6496-4f2d-9a74-340193d0e1e6"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"1d075de5-b9a1-44e2-aa89-f6aa923ab8ad","name":"Shape factor","guid":"ff08eaba-eb03-400d-b985-3ad0138bbafe"}],"displayNames":{"en":"Mechanical Properties English Display Name","fr":"Mechanical Properties French Display Name"},"name":"Mechanical Properties","guid":"aa6a7ef2-0e37-40a6-b3eb-11d502408281"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Create a new layout section.",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"5baea3f6-b788-43d2-8c63-76837983c604"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"5baea3f6-b788-43d2-8c63-76837983c604"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"5baea3f6-b788-43d2-8c63-76837983c604"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"5baea3f6-b788-43d2-8c63-76837983c604"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayoutSection"
+ },
+ "example": {"sectionDetailType":"slim","displayNames":{},"name":"Additional Properties","guid":"60042bab-7d33-4d41-adda-be7e9f3807ef"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Reorder the list of layout sections for a layout.",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSectionsInfo"
+ },
+ "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"
+ },
+ "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}": {
+ "get": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Get a layout section with a specified guid for a given layout.",
+ "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"
+ }
+ },
+ {
+ "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/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ "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":"4a163b60-265b-4d0e-947f-e97382cceb2a"}
+ },
+ "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":[{"itemType":"attribute","attributeType":"shortText","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"d9e75955-ed00-42e5-aa87-024a9d025f73","name":"Form","guid":"157d371f-bc25-499b-a61d-38d716cbce42"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[{"itemType":"attribute","attributeType":"longText","required":true,"readOnly":false,"underlyingEntityGuid":"6e5e9149-326e-4f3a-8570-6a96bb8b4e63","name":"Sources","guid":"1cc5254a-3005-47cb-a755-5eab97622902"},{"itemType":"attribute","attributeType":"shortText","required":true,"readOnly":false,"underlyingEntityGuid":"a694b0ca-b5b2-43df-b5b5-19f9dcf09532","name":"Notes","guid":"35116bc4-acf2-41f4-8dcf-62feaa026e57"}],"underlyingEntityGuid":"117a933a-3546-451b-86e1-99676b021b3c","name":"Chemical resistance","guid":"fd026d31-b900-4fc3-83f5-239887a68837"},{"itemType":"link","linkType":"recordLink","targetDatabase":"bab806cf-fb88-4bce-8f50-31baf60ebf94","targetDatabaseVersion":"1ea0ca90-2e3e-44b4-8387-c2097ade8eb6","targetTable":"d323ccba-c3bf-4f98-932a-609aa9702442","forwards":true,"underlyingEntityGuid":"076a4844-d19b-4648-b840-c640ca815502","name":"Material Pedigree","guid":"0e4fb551-9ba3-472d-9fb0-217140c398b1"},{"itemType":"attribute","attributeType":"link","required":false,"readOnly":false,"metaAttributes":[],"tabularColumns":[{"columnType":"linkedAttribute","tabularColumnGuid":"d3a21f90-2fbe-4b1b-8bf6-981e66f1452c","name":"Offset Yield Stress","guid":"69f64edc-ff32-44b3-af9e-0350cb3c9371"},{"columnType":"localShortText","tabularColumnGuid":"316c83a4-19cd-4310-ba63-944b126e2265","name":"Young's Modulus Notes","guid":"5ef858c0-aed4-4d19-95b6-8dcb4fecff45"}],"underlyingEntityGuid":"edbe698b-77e0-4da3-af5c-8b7b854135c4","name":"Reference Characteristics","guid":"f6ef0d9a-a0ae-4662-bab6-9af9612ced12"},{"itemType":"link","linkType":"associationChain","targetDatabase":"bab806cf-fb88-4bce-8f50-31baf60ebf94","targetDatabaseVersion":"1ea0ca90-2e3e-44b4-8387-c2097ade8eb6","targetTable":"64bbdc32-95ad-47f7-acfb-721efd751a56","forwards":true,"nextLink":{"itemType":"link","linkType":"associationChain","targetDatabase":"bab806cf-fb88-4bce-8f50-31baf60ebf94","targetDatabaseVersion":"1ea0ca90-2e3e-44b4-8387-c2097ade8eb6","targetTable":"9f6f5ecd-4693-42a5-a617-b89a2141e0d6","forwards":false,"underlyingEntityGuid":"144ce0ab-f185-44ba-a162-7a1cf2e8a0ad","name":"Pedigree information","guid":"4cb02aac-f492-40af-97e3-47413ec9c63f"},"underlyingEntityGuid":"555c2cd0-b4bf-43dc-b32e-01d42d94e7d4","name":"To Pedigree from Producers","guid":"bd299331-1aee-4bec-ba69-33659630856f"}],"displayNames":{"de":"Testing Information German Display Name","fr":"Testing Information French Display Name"},"name":"Testing Information","guid":"05ed0f86-4e8d-41b7-8243-4953dc4f0313"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table, layout or layout section not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Delete a layout section.",
+ "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, table, layout or layout 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.",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"9ba9643f-0d7f-4313-802d-2b74baeffef4","sourceTableGuid":"7f7de8d3-4509-4acd-92a0-27dd828c4364","linkGroupGuid":"b2bae57b-a036-4421-8424-ceedd8cbd4e1"}
+ },
+ "Example 16": {
+ "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":"440e2845-7c5b-48b6-af48-21dbbea3e592","tabularAttributeGuid":"c6a09099-b81b-466f-9850-7db370ca3f68"},{"forwards":false,"sourceDatabaseVersionGuid":"c0096a79-3f2b-46ea-9e34-57074238f053","tabularAttributeGuid":"40fa5cd8-e416-4cd2-b80f-f389633bba0d"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"9ba9643f-0d7f-4313-802d-2b74baeffef4","sourceTableGuid":"7f7de8d3-4509-4acd-92a0-27dd828c4364","linkGroupGuid":"b2bae57b-a036-4421-8424-ceedd8cbd4e1"}
+ },
+ "Example 16": {
+ "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":"440e2845-7c5b-48b6-af48-21dbbea3e592","tabularAttributeGuid":"c6a09099-b81b-466f-9850-7db370ca3f68"},{"forwards":false,"sourceDatabaseVersionGuid":"c0096a79-3f2b-46ea-9e34-57074238f053","tabularAttributeGuid":"40fa5cd8-e416-4cd2-b80f-f389633bba0d"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"9ba9643f-0d7f-4313-802d-2b74baeffef4","sourceTableGuid":"7f7de8d3-4509-4acd-92a0-27dd828c4364","linkGroupGuid":"b2bae57b-a036-4421-8424-ceedd8cbd4e1"}
+ },
+ "Example 16": {
+ "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":"440e2845-7c5b-48b6-af48-21dbbea3e592","tabularAttributeGuid":"c6a09099-b81b-466f-9850-7db370ca3f68"},{"forwards":false,"sourceDatabaseVersionGuid":"c0096a79-3f2b-46ea-9e34-57074238f053","tabularAttributeGuid":"40fa5cd8-e416-4cd2-b80f-f389633bba0d"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"9ba9643f-0d7f-4313-802d-2b74baeffef4","sourceTableGuid":"7f7de8d3-4509-4acd-92a0-27dd828c4364","linkGroupGuid":"b2bae57b-a036-4421-8424-ceedd8cbd4e1"}
+ },
+ "Example 16": {
+ "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":"440e2845-7c5b-48b6-af48-21dbbea3e592","tabularAttributeGuid":"c6a09099-b81b-466f-9850-7db370ca3f68"},{"forwards":false,"sourceDatabaseVersionGuid":"c0096a79-3f2b-46ea-9e34-57074238f053","tabularAttributeGuid":"40fa5cd8-e416-4cd2-b80f-f389633bba0d"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 8": {
+ "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":"b44a853e-838d-4d65-8998-8e13cdfd2493"}
+ },
+ "Example 9": {
+ "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":"4827c1bc-e437-4ecc-b90c-62253e6ddfc0"}
+ },
+ "Example 10": {
+ "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 11": {
+ "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","linkGroupGuid":"00e07ec0-695e-4ca3-bf1d-3bbeef126949","guid":null}
+ },
+ "Example 12": {
+ "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 13": {
+ "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":"2f081a2f-012c-480a-8e13-f80ecb699baf","sourceTableGuid":"db4ceb7b-3fbd-423d-b361-f3f17e8e1cdc","linkGroupGuid":"bcd6bce0-2415-47c7-a2f1-bbb275dbcc6b","guid":null}
+ },
+ "Example 14": {
+ "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":"f3afbe81-73d6-4227-a4bf-884ba2ec2609"},{"forwards":false,"sourceDatabaseVersionGuid":"00000000-0000-0000-0000-000000000000","tabularAttributeGuid":"a98f1562-8cf0-410a-bcc7-c20e8ecc7d56"}],"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.",
+ "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"
+ }
+ },
+ {
+ "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}/layouts": {
+ "get": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Get all layouts for table",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutsInfo"
+ },
+ "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 table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Create a new layout.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"09d7fa63-0799-41fa-9a83-41e8a8ef2672"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"09d7fa63-0799-41fa-9a83-41e8a8ef2672"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"09d7fa63-0799-41fa-9a83-41e8a8ef2672"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"09d7fa63-0799-41fa-9a83-41e8a8ef2672"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "example": {"displayNames":{},"name":"Ceramics","guid":"e6d5d436-d587-449a-a993-6c910653cbed"}
+ }
+ }
+ },
+ "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.",
+ "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/GrantaServerApiSchemaLayoutsLayout"
+ },
+ "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"}],"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":"d7bda699-746a-439d-970c-d46fc390b0e9","name":"Price","guid":"c7070afb-dc70-4e82-b0c4-f182f8ab5e3d"},{"itemType":"attribute","attributeType":"point","required":false,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"e41d919c-fb9a-403d-8751-6b891202102d","name":"Density","guid":"911f99c1-9ef5-4637-a1e7-837719b5d273"}],"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":"41fe5eed-faae-4ddf-9d40-ffff097e8f0f","name":"Young's modulus","guid":"af2e5a4d-5263-400d-bb1a-3530783c196b"},{"itemType":"attribute","attributeType":"range","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"b69d0c70-c919-4c79-b9f2-8b6781f2b5a3","name":"Tensile strength","guid":"b258c86e-d2a7-4614-9c59-6210a5ed08b6"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"d58f3481-196c-4faa-8bc6-127ddaaaa109","name":"Shape factor","guid":"a56dcbad-1a3b-4d54-ae0d-1a167c9fb71f"}],"displayNames":{"en":"Mechanical Properties English Display Name","fr":"Mechanical Properties French Display Name"},"name":"Mechanical Properties","guid":"aa6a7ef2-0e37-40a6-b3eb-11d502408281"}],"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"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Update a layout.",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"b7dba4d0-f064-4655-bc6c-40b267526cb0"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"b7dba4d0-f064-4655-bc6c-40b267526cb0"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"b7dba4d0-f064-4655-bc6c-40b267526cb0"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"b7dba4d0-f064-4655-bc6c-40b267526cb0"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayout"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Delete a layout.",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/parameters": {
+ "get": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Get all parameters for a given database.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParametersInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Create a new parameter.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"Colour"}
+ },
+ "Example 7": {
+ "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":"e55f25de-9ef3-4e44-8f40-f14ee13b272d"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Colour (guid)","guid":"e8d91afe-acf3-4516-96fb-a0d684efa466"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"Colour"}
+ },
+ "Example 7": {
+ "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":"e55f25de-9ef3-4e44-8f40-f14ee13b272d"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Colour (guid)","guid":"e8d91afe-acf3-4516-96fb-a0d684efa466"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"Colour"}
+ },
+ "Example 7": {
+ "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":"e55f25de-9ef3-4e44-8f40-f14ee13b272d"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Colour (guid)","guid":"e8d91afe-acf3-4516-96fb-a0d684efa466"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"Colour"}
+ },
+ "Example 7": {
+ "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":"e55f25de-9ef3-4e44-8f40-f14ee13b272d"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Colour (guid)","guid":"e8d91afe-acf3-4516-96fb-a0d684efa466"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "example": {"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"
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "example": {"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"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or parameter not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Update a parameter.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"18e771b0-9cd0-4825-bb78-3ea38c2b1458"}
+ },
+ "Example 9": {
+ "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":"c3fdc755-2f42-4b2d-8c8b-c7fa196715fb"}
+ },
+ "Example 10": {
+ "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":"a4398734-62ad-47ea-859d-b061d4e903f8"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"e2415ad1-8fd9-4f91-994b-e56fdefa9f62"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"18e771b0-9cd0-4825-bb78-3ea38c2b1458"}
+ },
+ "Example 9": {
+ "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":"c3fdc755-2f42-4b2d-8c8b-c7fa196715fb"}
+ },
+ "Example 10": {
+ "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":"a4398734-62ad-47ea-859d-b061d4e903f8"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"e2415ad1-8fd9-4f91-994b-e56fdefa9f62"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"18e771b0-9cd0-4825-bb78-3ea38c2b1458"}
+ },
+ "Example 9": {
+ "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":"c3fdc755-2f42-4b2d-8c8b-c7fa196715fb"}
+ },
+ "Example 10": {
+ "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":"a4398734-62ad-47ea-859d-b061d4e903f8"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"e2415ad1-8fd9-4f91-994b-e56fdefa9f62"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"18e771b0-9cd0-4825-bb78-3ea38c2b1458"}
+ },
+ "Example 9": {
+ "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":"c3fdc755-2f42-4b2d-8c8b-c7fa196715fb"}
+ },
+ "Example 10": {
+ "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":"a4398734-62ad-47ea-859d-b061d4e903f8"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"e2415ad1-8fd9-4f91-994b-e56fdefa9f62"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "example": {"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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or parameter not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Delete a parameter.",
+ "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": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsParameterDeletionException"
+ },
+ "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":"InUse","referencedByType":"Attribute","referencedBy":[{"name":"Stress","guid":"af033295-75d5-4f92-96cf-280c0142bf1e"}]}]}
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimObjects"
+ }
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/GrantaServerApiSchemaParametersParameterValue"
+ },
+ "example": {"type":"numeric","value":0.1,"guid":"173284fb-e557-406f-a7eb-f4e75f1d48a9"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, parameter or parameter value not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Update a parameter value.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"b301af73-ae75-4b12-9678-7afbabd8c147"}
+ },
+ "Example 5": {
+ "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":"d6a5f3cc-981c-4d89-9fe6-1b3fda4db4bb"}
+ },
+ "Example 6": {
+ "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":"ed63650a-8533-4e7a-811a-27feefa643c9"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"b301af73-ae75-4b12-9678-7afbabd8c147"}
+ },
+ "Example 5": {
+ "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":"d6a5f3cc-981c-4d89-9fe6-1b3fda4db4bb"}
+ },
+ "Example 6": {
+ "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":"ed63650a-8533-4e7a-811a-27feefa643c9"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"b301af73-ae75-4b12-9678-7afbabd8c147"}
+ },
+ "Example 5": {
+ "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":"d6a5f3cc-981c-4d89-9fe6-1b3fda4db4bb"}
+ },
+ "Example 6": {
+ "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":"ed63650a-8533-4e7a-811a-27feefa643c9"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"b301af73-ae75-4b12-9678-7afbabd8c147"}
+ },
+ "Example 5": {
+ "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":"d6a5f3cc-981c-4d89-9fe6-1b3fda4db4bb"}
+ },
+ "Example 6": {
+ "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":"ed63650a-8533-4e7a-811a-27feefa643c9"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterValue"
+ },
+ "example": {"type":"numeric","value":0.1,"guid":"173284fb-e557-406f-a7eb-f4e75f1d48a9"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Parameter in use."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database, parameter or parameter value not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Delete a parameter value.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/GrantaServerApiExceptionsParameterValueDeletionException"
+ },
+ "example": {"message":"Cannot delete parameter value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1').","code":400,"errors":[{"message":"It is being used in one or more parameters as a default value.","reason":"InUse","referencedByType":"DefaultParameterValue","referencedBy":[{"name":"Basis","guid":"7a6ccb7b-8a47-4cab-8203-c741d476560f"}]}]}
+ }
+ }
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersParameterValue"
+ },
+ "example": {"type":"numeric","value":0.1,"guid":"173284fb-e557-406f-a7eb-f4e75f1d48a9"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Parameter in use."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database or parameter not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/profiles": {
+ "get": {
+ "tags": [
+ "Schema - Profiles"
+ ],
+ "summary": "Get AllProfilesInfo",
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesAllProfilesInfo"
+ },
+ "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"},{"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",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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"}}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesAllProfilesInfo"
+ },
+ "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"},{"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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Profile not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Profiles"
+ ],
+ "summary": "Create a new profile",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"f3d522b6-f872-474b-b766-8cb9c47788b1"}
+ },
+ "Example 6": {
+ "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":"982ee0b6-7e71-422a-bb4f-6fc44df1ffe6"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"f3d522b6-f872-474b-b766-8cb9c47788b1"}
+ },
+ "Example 6": {
+ "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":"982ee0b6-7e71-422a-bb4f-6fc44df1ffe6"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"f3d522b6-f872-474b-b766-8cb9c47788b1"}
+ },
+ "Example 6": {
+ "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":"982ee0b6-7e71-422a-bb4f-6fc44df1ffe6"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"f3d522b6-f872-474b-b766-8cb9c47788b1"}
+ },
+ "Example 6": {
+ "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":"982ee0b6-7e71-422a-bb4f-6fc44df1ffe6"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesProfile"
+ },
+ "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"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/profiles/{profile-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Profiles"
+ ],
+ "summary": "Get individual profile",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesProfile"
+ },
+ "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",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"a4dcac2b-dbf8-4b91-8bff-da3d23b9a711"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"9bb3540d-c437-49d5-8af6-4ba3f5012dd6","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"a4dcac2b-dbf8-4b91-8bff-da3d23b9a711"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"9bb3540d-c437-49d5-8af6-4ba3f5012dd6","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"a4dcac2b-dbf8-4b91-8bff-da3d23b9a711"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"9bb3540d-c437-49d5-8af6-4ba3f5012dd6","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"a4dcac2b-dbf8-4b91-8bff-da3d23b9a711"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"9bb3540d-c437-49d5-8af6-4ba3f5012dd6","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesProfile"
+ },
+ "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"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Profile not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Profiles"
+ ],
+ "summary": "Delete a profile",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "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",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesProfileTablesInfo"
+ },
+ "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": "Profile not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - ProfileTables"
+ ],
+ "summary": "Create a new profile table",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"aa92d25c-c40f-4f89-9104-476c98a79e09"}
+ },
+ "Example 6": {
+ "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": {"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":"77ac4ec7-f97f-49d7-adbf-cdaae38973f4"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"aa92d25c-c40f-4f89-9104-476c98a79e09"}
+ },
+ "Example 6": {
+ "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": {"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":"77ac4ec7-f97f-49d7-adbf-cdaae38973f4"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"aa92d25c-c40f-4f89-9104-476c98a79e09"}
+ },
+ "Example 6": {
+ "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": {"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":"77ac4ec7-f97f-49d7-adbf-cdaae38973f4"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"aa92d25c-c40f-4f89-9104-476c98a79e09"}
+ },
+ "Example 6": {
+ "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": {"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":"77ac4ec7-f97f-49d7-adbf-cdaae38973f4"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesProfileTable"
+ },
+ "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",
+ "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/GrantaServerApiSchemaProfileTablesProfileTable"
+ },
+ "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",
+ "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/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"ebbbdfc5-0568-44ad-9a7e-340150a8a2e5"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"ca9b2247-a1b9-4ad4-bff8-1762baa046a0"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"ebbbdfc5-0568-44ad-9a7e-340150a8a2e5"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"ca9b2247-a1b9-4ad4-bff8-1762baa046a0"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"ebbbdfc5-0568-44ad-9a7e-340150a8a2e5"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"ca9b2247-a1b9-4ad4-bff8-1762baa046a0"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"ebbbdfc5-0568-44ad-9a7e-340150a8a2e5"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"ca9b2247-a1b9-4ad4-bff8-1762baa046a0"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesProfileTable"
+ },
+ "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",
+ "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}/tables/{table-guid}/record-link-groups": {
+ "get": {
+ "tags": [
+ "Schema - Record Link Groups"
+ ],
+ "summary": "Get all record link groups",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupsInfo"
+ },
+ "example": {"recordLinkGroups":[{"identity":115,"type":"static","reverseName":"Training Exercise","reverseDisplayNames":{},"displayNames":{},"name":"MaterialUniverse","guid":"00e07ec0-695e-4ca3-bf1d-3bbeef126949"},{"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"},"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":"7f5d7172-3ecc-4491-a5a4-a85f9a915f23"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Record Link Groups"
+ ],
+ "summary": "Create a new record link group.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"35604496-4b25-4a31-a28d-64cdbc75f88e"}
+ },
+ "Example 9": {
+ "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":"040d7913-a979-4870-a03f-500e5d48f5f6"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"e8b67aad-ce0d-478a-b120-14654a19ca4f","tableGuid":"e338dcae-84a1-4883-bd34-dc8785a8f1b2"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"ccebcc3d-c9ff-44fe-ab51-97d4f3a668c5"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"e7f52155-13ca-4fc3-87c2-7ffefdcfcc3e"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"35604496-4b25-4a31-a28d-64cdbc75f88e"}
+ },
+ "Example 9": {
+ "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":"040d7913-a979-4870-a03f-500e5d48f5f6"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"e8b67aad-ce0d-478a-b120-14654a19ca4f","tableGuid":"e338dcae-84a1-4883-bd34-dc8785a8f1b2"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"ccebcc3d-c9ff-44fe-ab51-97d4f3a668c5"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"e7f52155-13ca-4fc3-87c2-7ffefdcfcc3e"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"35604496-4b25-4a31-a28d-64cdbc75f88e"}
+ },
+ "Example 9": {
+ "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":"040d7913-a979-4870-a03f-500e5d48f5f6"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"e8b67aad-ce0d-478a-b120-14654a19ca4f","tableGuid":"e338dcae-84a1-4883-bd34-dc8785a8f1b2"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"ccebcc3d-c9ff-44fe-ab51-97d4f3a668c5"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"e7f52155-13ca-4fc3-87c2-7ffefdcfcc3e"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"35604496-4b25-4a31-a28d-64cdbc75f88e"}
+ },
+ "Example 9": {
+ "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":"040d7913-a979-4870-a03f-500e5d48f5f6"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"e8b67aad-ce0d-478a-b120-14654a19ca4f","tableGuid":"e338dcae-84a1-4883-bd34-dc8785a8f1b2"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"ccebcc3d-c9ff-44fe-ab51-97d4f3a668c5"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"e7f52155-13ca-4fc3-87c2-7ffefdcfcc3e"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ "examples": {
+ "Example 13": {
+ "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"}},"identity":125,"reverseName":"Fatigue Statistical Data","reverseDisplayNames":{},"displayNames":{},"name":"Fatigue Test Data","guid":"485da78d-d094-4edb-a5a9-077fe1bc02f2"}
+ },
+ "Example 14": {
+ "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"},"linkTarget":{"databaseGuid":"4d81ff26-6471-4a61-814f-8e0a6d9bddd4","tableGuid":"da23b32d-80bc-4bc0-af8c-6cf5ab75dc04"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"9989e5c0-0b7f-4590-a400-8477bfd318ad"}
+ },
+ "Example 15": {
+ "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":[{"attributeSource":{"type":"shortText","displayNames":{},"name":"Panel Number","guid":"6e50a7a8-a759-44c9-b151-215a07949c1f"},"attributeTarget":{"type":"shortText","displayNames":{},"name":"Panel Number","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"},"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 or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups:inbound-link-groups": {
+ "get": {
+ "tags": [
+ "Schema - Record Link Groups"
+ ],
+ "summary": "Get all record link groups pointing towards provided table",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupsInfo"
+ },
+ "example": {"recordLinkGroups":[{"identity":115,"type":"static","reverseName":"Training Exercise","reverseDisplayNames":{},"displayNames":{},"name":"MaterialUniverse","guid":"00e07ec0-695e-4ca3-bf1d-3bbeef126949"},{"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"},"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":"MI Training MaterialUniverse - Second Training Database And Table","reverseDisplayNames":{},"displayNames":{},"name":"Second Training Database And Table - MI Training MaterialUniverse","guid":"41bdbc8d-8d27-4fa4-a785-1189a71b2d82"}]}
+ }
+ }
+ },
+ "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",
+ "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-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": "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/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ "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"}},"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"},"linkTarget":{"databaseGuid":"7e640d81-b215-42e2-aada-041884103a88","tableGuid":"4b32b31e-b969-456a-91c1-602ec3adb623"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"f83084a6-cbe6-4d37-b659-016a6cff8936"}
+ },
+ "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": {"type":"dynamic","forbidOrphans":false,"referentialIntegrityModel":"oneToMany","attributePairs":[{"attributeSource":{"type":"shortText","displayNames":{},"name":"Panel Number","guid":"6e50a7a8-a759-44c9-b151-215a07949c1f"},"attributeTarget":{"type":"shortText","displayNames":{},"name":"Panel Number","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"},"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.",
+ "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-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"
+ },
+ "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.",
+ "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-link-group-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"ed8990ad-54f2-43d5-9b43-52ee05863647"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"34caa6cf-2c66-440c-9d43-ab99f32a94b7"}
+ },
+ "Example 9": {
+ "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":"3de44ec9-6e10-4810-8f0e-36c9e6133f29"}
+ },
+ "Example 10": {
+ "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":"ec432e00-81fc-44a3-87c1-1322064ccbf2"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"ed8990ad-54f2-43d5-9b43-52ee05863647"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"34caa6cf-2c66-440c-9d43-ab99f32a94b7"}
+ },
+ "Example 9": {
+ "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":"3de44ec9-6e10-4810-8f0e-36c9e6133f29"}
+ },
+ "Example 10": {
+ "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":"ec432e00-81fc-44a3-87c1-1322064ccbf2"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"ed8990ad-54f2-43d5-9b43-52ee05863647"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"34caa6cf-2c66-440c-9d43-ab99f32a94b7"}
+ },
+ "Example 9": {
+ "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":"3de44ec9-6e10-4810-8f0e-36c9e6133f29"}
+ },
+ "Example 10": {
+ "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":"ec432e00-81fc-44a3-87c1-1322064ccbf2"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"ed8990ad-54f2-43d5-9b43-52ee05863647"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"34caa6cf-2c66-440c-9d43-ab99f32a94b7"}
+ },
+ "Example 9": {
+ "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":"3de44ec9-6e10-4810-8f0e-36c9e6133f29"}
+ },
+ "Example 10": {
+ "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":"ec432e00-81fc-44a3-87c1-1322064ccbf2"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ "examples": {
+ "Example 16": {
+ "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"}},"identity":125,"reverseName":"Fatigue Statistical Data","reverseDisplayNames":{},"displayNames":{},"name":"Fatigue Test Data","guid":"485da78d-d094-4edb-a5a9-077fe1bc02f2"}
+ },
+ "Example 17": {
+ "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"},"linkTarget":{"databaseGuid":"0ebfb7b3-dbba-4e88-b612-9ab0f662058b","tableGuid":"16914db7-7396-4379-b962-325a3803b023"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"ba31fd5d-dc29-4b1c-961d-06088077f35a"}
+ },
+ "Example 18": {
+ "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":[{"attributeSource":{"type":"shortText","displayNames":{},"name":"Panel Number","guid":"6e50a7a8-a759-44c9-b151-215a07949c1f"},"attributeTarget":{"type":"shortText","displayNames":{},"name":"Panel Number","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"},"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 record link group not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/standard-names": {
+ "get": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Gets all standard names for a given database.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardNamesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Create a new standard name",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"a7324c29-835f-447c-b99e-bdb98b4ffc04"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"a7324c29-835f-447c-b99e-bdb98b4ffc04"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"a7324c29-835f-447c-b99e-bdb98b4ffc04"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"a7324c29-835f-447c-b99e-bdb98b4ffc04"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardName"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "standard-name-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardName"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or standard name not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Edit a standard name",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "standard-name-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"e97cb124-b3ab-488e-8cf2-ebe1b9980196"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"e97cb124-b3ab-488e-8cf2-ebe1b9980196"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"e97cb124-b3ab-488e-8cf2-ebe1b9980196"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"e97cb124-b3ab-488e-8cf2-ebe1b9980196"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesStandardName"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or standard name not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Delete a standard name.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsSubsetsInfo"
+ },
+ "example": {"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 or table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Subsets"
+ ],
+ "summary": "Create a new subset.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"62688732-cd54-49c7-b7f5-5ddf4c80a88f"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"62688732-cd54-49c7-b7f5-5ddf4c80a88f"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"62688732-cd54-49c7-b7f5-5ddf4c80a88f"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"62688732-cd54-49c7-b7f5-5ddf4c80a88f"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsSubset"
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "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",
+ "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/GrantaServerApiSchemaSubsetsSubset"
+ },
+ "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.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "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",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"b867f63a-8137-4bef-910f-4557eab7c9d4"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"b867f63a-8137-4bef-910f-4557eab7c9d4"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"b867f63a-8137-4bef-910f-4557eab7c9d4"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"b867f63a-8137-4bef-910f-4557eab7c9d4"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsSubset"
+ },
+ "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"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or subset not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Subsets"
+ ],
+ "summary": "Delete a subset.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "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",
+ "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": {
+ "get": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Get all tables",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTablesInfo"
+ },
+ "example": {"tables":[{"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"},{"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"isVersioned":true,"displayNames":{},"name":"Design Data","guid":"0000b5e2-0011-4fff-8fff-0000ffff0000"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Create a new table.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"b9c35d16-9819-412e-a14b-05e29e228996"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"b9c35d16-9819-412e-a14b-05e29e228996"}
+ },
+ "Example 6": {
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"b9c35d16-9819-412e-a14b-05e29e228996"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"b9c35d16-9819-412e-a14b-05e29e228996"}
+ },
+ "Example 6": {
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "example": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"isVersioned":false,"displayNames":{},"name":"Material Universe","guid":"0000dd92-0011-4fff-8fff-0000ffff0000"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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.",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "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"}],"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 table not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Update a table.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"e34aa139-cf66-4b2d-8c11-650d4a56cf8e"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"e34aa139-cf66-4b2d-8c11-650d4a56cf8e"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"e34aa139-cf66-4b2d-8c11-650d4a56cf8e"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"e34aa139-cf66-4b2d-8c11-650d4a56cf8e"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "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"}],"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"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Delete a table.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request. Table in use.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsTableDeletionException"
+ },
+ "example": {"message":"Cannot delete table 'Restricted Substances' (GUID = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f').","code":400,"errors":[{"message":"It is being used in one or more tabular attributes.","reason":"InUse","referencedByType":"TabularAttribute","referencedBy":[{"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}/units/{unit-guid}/equivalent-units": {
+ "get": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Get equivalent units (one per unit system)",
+ "parameters": [
+ {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitEquivalentsInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ }
+ },
+ "/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 - Units"
+ ],
+ "summary": "Set the equivalent unit for a given unit system",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "unit-system-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "equivalent-unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "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",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitsInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Create a new unit.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/units/{unit-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Get individual units",
+ "parameters": [
+ {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Update unit.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Delete unit.",
+ "parameters": [
+ {
+ "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",
+ "parameters": [
+ {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitsInfo"
+ }
+ }
+ }
+ },
+ "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",
+ "parameters": [
+ {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitUsage"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/unit-systems": {
+ "get": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Get all unit systems in the database",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystemsInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Create a new unit system.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"946a2bec-7e5d-40ca-8eda-590bb01c068a"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"946a2bec-7e5d-40ca-8eda-590bb01c068a"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"946a2bec-7e5d-40ca-8eda-590bb01c068a"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"946a2bec-7e5d-40ca-8eda-590bb01c068a"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ }
+ }
+ }
+ },
+ "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",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-system-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit system not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Update a unit system.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-system-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"2f4593d5-88bc-4083-889b-f731c1c93eeb"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"ce04cff8-db23-429a-a641-1d009b1e9777"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"2f4593d5-88bc-4083-889b-f731c1c93eeb"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"ce04cff8-db23-429a-a641-1d009b1e9777"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"2f4593d5-88bc-4083-889b-f731c1c93eeb"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"ce04cff8-db23-429a-a641-1d009b1e9777"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"2f4593d5-88bc-4083-889b-f731c1c93eeb"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"ce04cff8-db23-429a-a641-1d009b1e9777"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or unit system not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Delete a unit system.",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/{database-key}/tables/{table-identity}:search": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "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/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["4ae4ed05-fb7d-4ebd-9ccd-83f6aef49e81","62f08cbc-517e-42d4-b38f-d089071d31c6"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["4ae4ed05-fb7d-4ebd-9ccd-83f6aef49e81","62f08cbc-517e-42d4-b38f-d089071d31c6"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["4ae4ed05-fb7d-4ebd-9ccd-83f6aef49e81","62f08cbc-517e-42d4-b38f-d089071d31c6"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["4ae4ed05-fb7d-4ebd-9ccd-83f6aef49e81","62f08cbc-517e-42d4-b38f-d089071d31c6"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}:search": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "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/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["022fdc87-bccf-4a31-ab20-a7b2ac521beb","9a0a165a-d5e9-499b-8315-897488f6a8cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["022fdc87-bccf-4a31-ab20-a7b2ac521beb","9a0a165a-d5e9-499b-8315-897488f6a8cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["022fdc87-bccf-4a31-ab20-a7b2ac521beb","9a0a165a-d5e9-499b-8315-897488f6a8cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["022fdc87-bccf-4a31-ab20-a7b2ac521beb","9a0a165a-d5e9-499b-8315-897488f6a8cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:search": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "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/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["0fb09303-a006-4555-b701-61d4dd2560fb","5393d928-a0c3-4c0f-a7fe-2c23a6cfbfa1"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["0fb09303-a006-4555-b701-61d4dd2560fb","5393d928-a0c3-4c0f-a7fe-2c23a6cfbfa1"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["0fb09303-a006-4555-b701-61d4dd2560fb","5393d928-a0c3-4c0f-a7fe-2c23a6cfbfa1"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 57": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["0fb09303-a006-4555-b701-61d4dd2560fb","5393d928-a0c3-4c0f-a7fe-2c23a6cfbfa1"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:search": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Runs a search against the integration schema.",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["f5cbc768-8405-4c38-bf90-134715cc437c","134fdb88-94a7-44a5-b4de-32fe6d7444b9"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["f5cbc768-8405-4c38-bf90-134715cc437c","134fdb88-94a7-44a5-b4de-32fe6d7444b9"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["f5cbc768-8405-4c38-bf90-134715cc437c","134fdb88-94a7-44a5-b4de-32fe6d7444b9"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "summary": "Free text search",
+ "description": "This example demonstrates how to create a new free text search with results sorted by relevance",
+ "value": {"criterion":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":{"identities":[-4,928,886],"identitiesToBoost":[{"identity":-4,"boostFactor":20.0}],"guids":[],"freeTextCriterionType":"specifiedAttributes","value":"lead","type":"text"},"sortCriteria":[]}
+ },
+ "Example 84": {
+ "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":{"columnIdentitiesToExclude":[],"columnGuidsToExclude":["d5c215fe-6305-407b-a830-cc5ff14e4cf9","bfb3edea-be3e-4598-a711-6abb171a4569"],"freeTextCriterionType":"excludingLocalColumns","value":"Intermediate","type":"text"},"sortCriteria":[]}
+ },
+ "Example 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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":[{"freeTextCriterionType":"all","value":"steel","type":"text"},{"all":[{"innerCriterion":{"type":"integer"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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":[],"textMatchBehaviour":"contains","type":"discreteTextValues"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["f5cbc768-8405-4c38-bf90-134715cc437c","134fdb88-94a7-44a5-b4de-32fe6d7444b9"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehaviour":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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","textMatchBehaviour":"exactMatch","type":"discreteText"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"],"linkingValueMatchBehaviour":"FreeTextMatchingRows","type":"tabularLinkingValue"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":"floatFunctionalData"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehaviour":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":{"freeTextCriterionType":"all","value":"steel","type":"text"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/searches/{searchIdentifier}/results": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Search not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/searches/{searchIdentifier}": {
+ "delete": {
+ "tags": [
+ "Search"
+ ],
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "404": {
+ "description": "Search not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/selection-searches": {
+ "get": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Returns all searches visible to the calling user.",
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Creates a new search with the specified properties.",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/selection-searches/search": {
+ "post": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Retrieves a collection of searches that match the specified criteria.",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/selection-searches/search/{searchIdentifier}": {
+ "get": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Returns the given search if it exists and the calling user has access to it",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Search result not found"
+ },
+ "410": {
+ "description": "Search result no longer available"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "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.",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Search not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Delete an existing selection search.",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Selection search not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/status": {
+ "get": {
+ "tags": [
+ "Status"
+ ],
+ "summary": "Check whether the API is available",
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "GrantaMISearchRecordPropertyFakeAttributeNumbers": {
+ "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"
+ },
+ "GrantaServerApiAdminMiVersion": {
+ "type": "object",
+ "properties": {
+ "binaryCompatibilityVersion": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ },
+ "majorMinorVersion": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsAggregation": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The results of aggregation.\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeAggregation\r\n * GrantaServerApiAggregationsFreeTextAggregation",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregation",
+ "text": "#/components/schemas/GrantaServerApiAggregationsFreeTextAggregation"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationCriterion": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeAggregationCriterion\r\n * GrantaServerApiAggregationsFreeTextAggregationCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationCriterion",
+ "text": "#/components/schemas/GrantaServerApiAggregationsFreeTextAggregationCriterion"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationDatum": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsIntegerAggregation\r\n * GrantaServerApiAggregationsPointAggregation\r\n * GrantaServerApiAggregationsRangeAggregation\r\n * GrantaServerApiAggregationsIntegerHistogramAggregation\r\n * GrantaServerApiAggregationsPointHistogramAggregation\r\n * GrantaServerApiAggregationsRangeHistogramAggregation\r\n * GrantaServerApiAggregationsDateTimeAggregation\r\n * GrantaServerApiAggregationsDateTimeHistogramAggregation\r\n * GrantaServerApiAggregationsShortTextAggregation\r\n * GrantaServerApiAggregationsDiscreteTextAggregation\r\n * GrantaServerApiAggregationsLinkAggregation\r\n * GrantaServerApiAggregationsLogicalAggregation\r\n * GrantaServerApiAggregationsFloatFunctionalAggregation",
+ "discriminator": {
+ "propertyName": "datumType",
+ "mapping": {
+ "integer": "#/components/schemas/GrantaServerApiAggregationsIntegerAggregation",
+ "point": "#/components/schemas/GrantaServerApiAggregationsPointAggregation",
+ "range": "#/components/schemas/GrantaServerApiAggregationsRangeAggregation",
+ "integerHistogram": "#/components/schemas/GrantaServerApiAggregationsIntegerHistogramAggregation",
+ "pointHistogram": "#/components/schemas/GrantaServerApiAggregationsPointHistogramAggregation",
+ "rangeHistogram": "#/components/schemas/GrantaServerApiAggregationsRangeHistogramAggregation",
+ "dateTime": "#/components/schemas/GrantaServerApiAggregationsDateTimeAggregation",
+ "dateTimeHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogramAggregation",
+ "shortText": "#/components/schemas/GrantaServerApiAggregationsShortTextAggregation",
+ "discreteText": "#/components/schemas/GrantaServerApiAggregationsDiscreteTextAggregation",
+ "link": "#/components/schemas/GrantaServerApiAggregationsLinkAggregation",
+ "logical": "#/components/schemas/GrantaServerApiAggregationsLogicalAggregation",
+ "floatFunctionalGraph": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalAggregation"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationDatumCriterion": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsDateTimeAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDateTimeHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDateTimeFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDiscreteTextAggregationDatumCriterion\r\n * GrantaServerApiAggregationsIntegerAggregationDatumCriterion\r\n * GrantaServerApiAggregationsPointAggregationDatumCriterion\r\n * GrantaServerApiAggregationsRangeAggregationDatumCriterion\r\n * GrantaServerApiAggregationsIntegerHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsIntegerFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsPointHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsPointFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsRangeHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsRangeFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsShortTextAggregationDatumCriterion\r\n * GrantaServerApiAggregationsLinkAggregationDatumCriterion\r\n * GrantaServerApiAggregationsLogicalAggregationDatumCriterion\r\n * GrantaServerApiAggregationsFloatFunctionalAggregationDatumCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "dateTime": "#/components/schemas/GrantaServerApiAggregationsDateTimeAggregationDatumCriterion",
+ "dateTimeHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogramAggregationDatumCriterion",
+ "dateTimeFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeFixedWidthHistogramAggregationDatumCriterion",
+ "dateTimeFixedCalendarWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion",
+ "discreteText": "#/components/schemas/GrantaServerApiAggregationsDiscreteTextAggregationDatumCriterion",
+ "integer": "#/components/schemas/GrantaServerApiAggregationsIntegerAggregationDatumCriterion",
+ "point": "#/components/schemas/GrantaServerApiAggregationsPointAggregationDatumCriterion",
+ "range": "#/components/schemas/GrantaServerApiAggregationsRangeAggregationDatumCriterion",
+ "integerHistogram": "#/components/schemas/GrantaServerApiAggregationsIntegerHistogramAggregationDatumCriterion",
+ "integerFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsIntegerFixedWidthHistogramAggregationDatumCriterion",
+ "pointHistogram": "#/components/schemas/GrantaServerApiAggregationsPointHistogramAggregationDatumCriterion",
+ "pointFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsPointFixedWidthHistogramAggregationDatumCriterion",
+ "rangeHistogram": "#/components/schemas/GrantaServerApiAggregationsRangeHistogramAggregationDatumCriterion",
+ "rangeFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsRangeFixedWidthHistogramAggregationDatumCriterion",
+ "shortText": "#/components/schemas/GrantaServerApiAggregationsShortTextAggregationDatumCriterion",
+ "link": "#/components/schemas/GrantaServerApiAggregationsLinkAggregationDatumCriterion",
+ "logical": "#/components/schemas/GrantaServerApiAggregationsLogicalAggregationDatumCriterion",
+ "floatFunctionalGraph": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalAggregationDatumCriterion"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationDatumExistsCriterion": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ }
+ },
+ "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"
+ },
+ "GrantaServerApiAggregationsAggregationsRequest": {
+ "type": "object",
+ "properties": {
+ "criterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "aggregationCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationCriterion"
+ },
+ "description": "The aggregations you wish to perform.",
+ "nullable": true
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiAggregationsAggregationsResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregation"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsAttributeAggregation": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregation"
+ }
+ ],
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ },
+ "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"
+ }
+ },
+ "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: GrantaServerApiAggregationsAggregation\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeValueAggregation\r\n * GrantaServerApiAggregationsAttributeExistsAggregation",
+ "discriminator": {
+ "propertyName": "attributeAggregationType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsAttributeValueAggregation",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsAttributeExistsAggregation"
+ }
+ },
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiAggregationsAttributeAggregationCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationCriterion"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "isMetaAttribute": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ },
+ "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: GrantaServerApiAggregationsAggregationCriterion\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeAggregationValueCriterion\r\n * GrantaServerApiAggregationsAttributeAggregationExistsCriterion",
+ "discriminator": {
+ "propertyName": "attributeAggregationCriterionType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationValueCriterion",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationExistsCriterion"
+ }
+ },
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiAggregationsAttributeAggregationExistsCriterion": {
+ "required": [
+ "attributeAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationCriterionType": {
+ "type": "string",
+ "default": "exists"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumExistsCriterion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute.\r\n\r\nThis extends: GrantaServerApiAggregationsAttributeAggregationCriterion",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsAttributeAggregationValueCriterion": {
+ "required": [
+ "attributeAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationCriterionType": {
+ "type": "string",
+ "default": "value"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAttributeAggregationCriterion",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsAttributeExistsAggregation": {
+ "required": [
+ "attributeAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationType": {
+ "type": "string",
+ "default": "exists"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAttributeAggregation",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsAttributeValueAggregation": {
+ "required": [
+ "attributeAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationType": {
+ "type": "string",
+ "default": "value"
+ },
+ "aggregationDatum": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiAggregationsAttributeAggregation",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsCalendarInterval": {
+ "enum": [
+ "minute",
+ "hour",
+ "day",
+ "week",
+ "month",
+ "quarter",
+ "year"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiAggregationsDateTimeAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiAggregationsDateTimeAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiAggregationsDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "interval": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsCalendarInterval"
+ },
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTimeFixedCalendarWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTimeFixedCalendarWidthHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "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)",
+ "nullable": true
+ },
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTimeFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTimeFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeHistogram": {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogramBucket"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsDateTimeHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "dateTimeHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "dateTimeHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "description": "The maximum number of buckets to return.",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTimeHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTimeHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeHistogramBucket": {
+ "type": "object",
+ "properties": {
+ "lower": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsDiscreteTextAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "terms": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsTermWithCount"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "discreteText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "discreteText"
+ },
+ "GrantaServerApiAggregationsDiscreteTextAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "discreteText"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "discreteText"
+ },
+ "GrantaServerApiAggregationsFloatFunctionalAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "seriesGraphs": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalSeriesGraphAggregation"
+ },
+ "gridGraphs": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalGridGraphAggregation"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "floatFunctionalGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "floatFunctionalGraph"
+ },
+ "GrantaServerApiAggregationsFloatFunctionalAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "numberOfParameterValues": {
+ "type": "integer",
+ "description": "The maximum number of values to return in this aggregation.",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "floatFunctionalGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion for aggregating the graph information within a float functional attribute.\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "floatFunctionalGraph"
+ },
+ "GrantaServerApiAggregationsFloatFunctionalGridGraphAggregation": {
+ "type": "object",
+ "properties": {
+ "defaultXAxisParameterIdentityValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemInt32"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "defaultXAxisParameterGuidValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemGuid"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "showAsTableValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemBoolean"
+ },
+ "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
+ },
+ "GrantaServerApiAggregationsFloatFunctionalSeriesGraphAggregation": {
+ "type": "object",
+ "properties": {
+ "xAxisParameterIdentityValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemInt32"
+ },
+ "nullable": true
+ },
+ "xAxisParameterGuidValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemGuid"
+ },
+ "nullable": true
+ },
+ "showAsTableValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemBoolean"
+ },
+ "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
+ },
+ "GrantaServerApiAggregationsFreeTextAggregation": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "description": "The GUID of the input aggregation criterion.",
+ "format": "uuid"
+ },
+ "terms": {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "The results of aggregation over an attribute.\r\n\r\nThis extends: GrantaServerApiAggregationsAggregation",
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiAggregationsFreeTextAggregationCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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/GrantaServerApiValueSpecifier"
+ },
+ "localColumns": {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationCriterion",
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiAggregationsHistogram": {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogramBucket"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsHistogramBucket": {
+ "type": "object",
+ "properties": {
+ "lower": {
+ "type": "number",
+ "format": "double"
+ },
+ "upper": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsIntegerAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "integer"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiAggregationsIntegerAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiAggregationsIntegerFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "type": {
+ "type": "string",
+ "default": "integerFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "integerFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsIntegerHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "integerHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "integerHistogram"
+ },
+ "GrantaServerApiAggregationsIntegerHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "integerHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "integerHistogram"
+ },
+ "GrantaServerApiAggregationsLinkAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localAggregations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregation"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "link"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiAggregationsLinkAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "localAggregationCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationCriterion"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregation": {
+ "type": "object",
+ "properties": {
+ "localColumnIdentity": {
+ "type": "integer",
+ "description": "The identity of the local column that was aggregated over.",
+ "format": "int32",
+ "nullable": true
+ },
+ "localColumnGuid": {
+ "type": "string",
+ "description": "The GUID of the local column that was aggregated over.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "description": "The number of records that have a populated (applicable) value for this local column.",
+ "format": "int32"
+ }
+ },
+ "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 * GrantaServerApiAggregationsLocalColumnValueAggregation\r\n * GrantaServerApiAggregationsLocalColumnExistsAggregation",
+ "discriminator": {
+ "propertyName": "localColumnAggregationType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsLocalColumnValueAggregation",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsLocalColumnExistsAggregation"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregationCriterion": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "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 * GrantaServerApiAggregationsLocalColumnAggregationValueCriterion\r\n * GrantaServerApiAggregationsLocalColumnAggregationExistsCriterion",
+ "discriminator": {
+ "propertyName": "localColumnAggregationCriterionType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationValueCriterion",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationExistsCriterion"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregationExistsCriterion": {
+ "required": [
+ "localColumnAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localColumnAggregationCriterionType": {
+ "type": "string",
+ "default": "exists"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumExistsCriterion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A criterion for requesting aggregations for a single specific tabular local column.\r\n\r\nThis extends: GrantaServerApiAggregationsLocalColumnAggregationCriterion",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregationValueCriterion": {
+ "required": [
+ "localColumnAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localColumnAggregationCriterionType": {
+ "type": "string",
+ "default": "value"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsLocalColumnAggregationCriterion",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsLocalColumnExistsAggregation": {
+ "required": [
+ "localColumnAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localColumnAggregationType": {
+ "type": "string",
+ "default": "exists"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsLocalColumnAggregation",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsLocalColumnValueAggregation": {
+ "required": [
+ "localColumnAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "aggregationDatum": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ "localColumnAggregationType": {
+ "type": "string",
+ "default": "value"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsLocalColumnAggregation",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsLogicalAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemBoolean"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiAggregationsLogicalAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiAggregationsPointAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "point"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiAggregationsPointAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiAggregationsPointFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "type": {
+ "type": "string",
+ "default": "pointFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "pointFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsPointHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "pointHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "pointHistogram"
+ },
+ "GrantaServerApiAggregationsPointHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "pointHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "pointHistogram"
+ },
+ "GrantaServerApiAggregationsRangeAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "range"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiAggregationsRangeAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiAggregationsRangeFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "type": {
+ "type": "string",
+ "default": "rangeFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "rangeFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsRangeHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "rangeHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "rangeHistogram"
+ },
+ "GrantaServerApiAggregationsRangeHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "rangeHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "rangeHistogram"
+ },
+ "GrantaServerApiAggregationsShortTextAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "terms": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsTermWithCount"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "shortText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiAggregationsShortTextAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "shortText"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiAggregationsTermWithCount": {
+ "type": "object",
+ "properties": {
+ "term": {
+ "type": "string",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A term from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAggregationsValueWithCountOfSystemBoolean": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAggregationsValueWithCountOfSystemGuid": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAggregationsValueWithCountOfSystemInt32": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAllValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filterOn": {
+ "type": "string",
+ "default": "all"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Specifies no filtering.\r\n\r\nThis extends: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "all"
+ },
+ "GrantaServerApiAppNameLicenseCheckoutRequest": {
+ "type": "object",
+ "properties": {
+ "appNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAppNameLicenseCheckoutResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResult"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAppNameLicenseCheckoutResult": {
+ "type": "object",
+ "properties": {
+ "appName": {
+ "type": "string",
+ "nullable": true
+ },
+ "licenseStateOk": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsCreateJobRequest": {
+ "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
+ },
+ "GrantaServerApiAsyncJobsGetJobsResponse": {
+ "type": "object",
+ "properties": {
+ "totalResultCount": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsJob": {
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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/GrantaServerApiAsyncJobsJobStatus"
+ },
+ "inputFileIds": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsJobStatus": {
+ "enum": [
+ "Pending",
+ "Running",
+ "Succeeded",
+ "Failed",
+ "Cancelled"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiAsyncJobsProcessingConfig": {
+ "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
+ },
+ "GrantaServerApiAsyncJobsResubmitJobRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "scheduledExecutionDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsUpdateJobRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "scheduledExecutionDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJobStatus"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAttributeType": {
+ "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."
+ },
+ "GrantaServerApiDataExportAttributeToExport": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportLinkAttributeToExport\r\n * GrantaServerApiDataExportSimpleAttributeToExport",
+ "discriminator": {
+ "propertyName": "attributeType",
+ "mapping": {
+ "link": "#/components/schemas/GrantaServerApiDataExportLinkAttributeToExport",
+ "simple": "#/components/schemas/GrantaServerApiDataExportSimpleAttributeToExport"
+ }
+ }
+ },
+ "GrantaServerApiDataExportDataExportRequest": {
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ "nullable": true
+ },
+ "recordProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordProperty"
+ },
+ "nullable": true
+ },
+ "recordHistoryIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "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"
+ },
+ "GrantaServerApiDataExportDataExportResponse": {
+ "required": [
+ "failures",
+ "results"
+ ],
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportRecordWithData"
+ }
+ },
+ "failures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ "description": "List the records that were requested, but that we failed to export any data for."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsApplicableDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ }
+ ],
+ "properties": {
+ "notApplicable": {
+ "type": "string",
+ "default": "applicable"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsBooleanDatum\r\n * GrantaServerApiDataExportDatumsDateTimeDatum\r\n * GrantaServerApiDataExportDatumsDiscreteDatum\r\n * GrantaServerApiDataExportDatumsFileDatum\r\n * GrantaServerApiDataExportDatumsFloatFunctionalDatum\r\n * GrantaServerApiDataExportDatumsDiscreteFunctionalDatum\r\n * GrantaServerApiDataExportDatumsHyperlinkDatum\r\n * GrantaServerApiDataExportDatumsLinkDatum\r\n * GrantaServerApiDataExportDatumsLongTextDatum\r\n * GrantaServerApiDataExportDatumsNumericDatum\r\n * GrantaServerApiDataExportDatumsPictureDatum\r\n * GrantaServerApiDataExportDatumsPointDatum\r\n * GrantaServerApiDataExportDatumsRangeDatum\r\n * GrantaServerApiDataExportDatumsShortTextDatum",
+ "discriminator": {
+ "propertyName": "datumType",
+ "mapping": {
+ "logical": "#/components/schemas/GrantaServerApiDataExportDatumsBooleanDatum",
+ "dateTime": "#/components/schemas/GrantaServerApiDataExportDatumsDateTimeDatum",
+ "discrete": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteDatum",
+ "file": "#/components/schemas/GrantaServerApiDataExportDatumsFileDatum",
+ "floatFunctional": "#/components/schemas/GrantaServerApiDataExportDatumsFloatFunctionalDatum",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalDatum",
+ "hyperlink": "#/components/schemas/GrantaServerApiDataExportDatumsHyperlinkDatum",
+ "link": "#/components/schemas/GrantaServerApiDataExportDatumsLinkDatum",
+ "longText": "#/components/schemas/GrantaServerApiDataExportDatumsLongTextDatum",
+ "integer": "#/components/schemas/GrantaServerApiDataExportDatumsNumericDatum",
+ "picture": "#/components/schemas/GrantaServerApiDataExportDatumsPictureDatum",
+ "point": "#/components/schemas/GrantaServerApiDataExportDatumsPointDatum",
+ "range": "#/components/schemas/GrantaServerApiDataExportDatumsRangeDatum",
+ "shortText": "#/components/schemas/GrantaServerApiDataExportDatumsShortTextDatum"
+ }
+ },
+ "x-discriminator-value": "applicable"
+ },
+ "GrantaServerApiDataExportDatumsBinaryData": {
+ "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
+ },
+ "GrantaServerApiDataExportDatumsBooleanDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "logical"
+ },
+ "datumValue": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiDataExportDatumsDateTimeDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "dateTime"
+ },
+ "datumValue": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiDataExportDatumsDatum": {
+ "type": "object",
+ "properties": {
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "metaDatums": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsNotApplicableDatum\r\n * GrantaServerApiDataExportDatumsApplicableDatum\r\n * GrantaServerApiDataExportDatumsUnknownDatum",
+ "discriminator": {
+ "propertyName": "notApplicable",
+ "mapping": {
+ "notApplicable": "#/components/schemas/GrantaServerApiDataExportDatumsNotApplicableDatum",
+ "applicable": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum",
+ "unknown": "#/components/schemas/GrantaServerApiDataExportDatumsUnknownDatum"
+ }
+ }
+ },
+ "GrantaServerApiDataExportDatumsDiscreteDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "datumValue": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDiscreteValue"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteFunctionalDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ }
+ ],
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "xAxisParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsDiscreteFunctionalGridDatum\r\n * GrantaServerApiDataExportDatumsDiscreteFunctionalSeriesDatum",
+ "discriminator": {
+ "propertyName": "graphType",
+ "mapping": {
+ "grid": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalGridDatum",
+ "series": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalSeriesDatum"
+ }
+ },
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteFunctionalGridDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "grid"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteGridPoint"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDiscreteFunctionalDatum",
+ "x-discriminator-value": "grid"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteFunctionalSeriesDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "series"
+ },
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteSeries"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDiscreteFunctionalDatum",
+ "x-discriminator-value": "series"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteGridPoint": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "value": {
+ "$ref": "#/components/schemas/GrantaServerApiDiscreteValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsDiscreteSeries": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteSeriesPoint"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsDiscreteSeriesPoint": {
+ "type": "object",
+ "properties": {
+ "x": {
+ "type": "number",
+ "format": "double"
+ },
+ "xName": {
+ "type": "string",
+ "nullable": true
+ },
+ "y": {
+ "$ref": "#/components/schemas/GrantaServerApiDiscreteValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsFileDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "file"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsBinaryData"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiDataExportDatumsFloatFunctionalDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ }
+ ],
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "xAxisParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "nullable": true
+ },
+ "isEstimated": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsFunctionalGridDatum\r\n * GrantaServerApiDataExportDatumsFunctionalSeriesDatum",
+ "discriminator": {
+ "propertyName": "graphType",
+ "mapping": {
+ "grid": "#/components/schemas/GrantaServerApiDataExportDatumsFunctionalGridDatum",
+ "series": "#/components/schemas/GrantaServerApiDataExportDatumsFunctionalSeriesDatum"
+ }
+ },
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiDataExportDatumsFunctionalGridDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsFloatFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "grid"
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsGridPoint"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsFloatFunctionalDatum",
+ "x-discriminator-value": "grid"
+ },
+ "GrantaServerApiDataExportDatumsFunctionalSeriesDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsFloatFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "series"
+ },
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsSeries"
+ },
+ "nullable": true
+ },
+ "isLogarithmic": {
+ "type": "boolean"
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "showAsTable": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsFloatFunctionalDatum",
+ "x-discriminator-value": "series"
+ },
+ "GrantaServerApiDataExportDatumsGraphDecoration": {
+ "enum": [
+ "Lines",
+ "Markers",
+ "LinesAndMarkers"
+ ],
+ "type": "string",
+ "description": "Indicates how a graphical representation of a graph should be rendered"
+ },
+ "GrantaServerApiDataExportDatumsGridPoint": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "low": {
+ "type": "number",
+ "format": "double"
+ },
+ "high": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsHyperlink": {
+ "type": "object",
+ "properties": {
+ "address": {
+ "type": "string",
+ "nullable": true
+ },
+ "formattedAddress": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsHyperlinkDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "hyperlink"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsHyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiDataExportDatumsLinkDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ }
+ ],
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "link"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsLinkedRecordsDatum\r\n * GrantaServerApiDataExportDatumsTabularDatum",
+ "discriminator": {
+ "propertyName": "linkDatumType",
+ "mapping": {
+ "linkGroup": "#/components/schemas/GrantaServerApiDataExportDatumsLinkedRecordsDatum",
+ "tabular": "#/components/schemas/GrantaServerApiDataExportDatumsTabularDatum"
+ }
+ },
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiDataExportDatumsLinkedRecordsDatum": {
+ "required": [
+ "linkDatumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsLinkDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "linkGroupName": {
+ "type": "string",
+ "nullable": true
+ },
+ "linkAttributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "exportInReversedDirection": {
+ "type": "boolean"
+ },
+ "targetDatabaseGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "linkedRecords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportRecordWithData"
+ },
+ "nullable": true
+ },
+ "linkGroupNamesByDatabaseKey": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "linkGroupIdentitiesByDatabaseKey": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "rolledUpData": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ "nullable": true
+ },
+ "linkDatumType": {
+ "type": "string",
+ "default": "linkGroup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsLinkDatum",
+ "x-discriminator-value": "linkGroup"
+ },
+ "GrantaServerApiDataExportDatumsLongTextDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "longText"
+ },
+ "datumValue": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiDataExportDatumsNotApplicableDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "notApplicable": {
+ "type": "string",
+ "default": "notApplicable"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDatum",
+ "x-discriminator-value": "notApplicable"
+ },
+ "GrantaServerApiDataExportDatumsNumericDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "integer"
+ },
+ "datumValue": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiDataExportDatumsParameterValue": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfo"
+ },
+ "valueName": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsPictureDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "picture"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsBinaryData"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiDataExportDatumsPoint": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsPointDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "point"
+ },
+ "datumValue": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsPoint"
+ },
+ "nullable": true
+ },
+ "isEstimated": {
+ "type": "boolean"
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiDataExportDatumsRange": {
+ "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
+ },
+ "GrantaServerApiDataExportDatumsRangeDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "range"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRange"
+ },
+ "isEstimated": {
+ "type": "boolean"
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiDataExportDatumsRollupCountRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "countRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A count of the number of populated values\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "countRollup"
+ },
+ "GrantaServerApiDataExportDatumsRollupNumericRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "statisticalRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A statistical rollup of a set of numeric values\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "statisticalRollup"
+ },
+ "GrantaServerApiDataExportDatumsRollupRollupDatum": {
+ "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/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsRollupNumericRollupDatum\r\n * GrantaServerApiDataExportDatumsRollupValueRollupDatum\r\n * GrantaServerApiDataExportDatumsRollupValuesRollupDatum\r\n * GrantaServerApiDataExportDatumsRollupCountRollupDatum",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "statisticalRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupNumericRollupDatum",
+ "valueRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupValueRollupDatum",
+ "valuesRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupValuesRollupDatum",
+ "countRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupCountRollupDatum"
+ }
+ }
+ },
+ "GrantaServerApiDataExportDatumsRollupValueRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "object",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "valueRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A rollup where the value is a single object (such as a discrete value)\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "valueRollup"
+ },
+ "GrantaServerApiDataExportDatumsRollupValuesRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "nullable": true
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "valuesRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A rollup to a list of values\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "valuesRollup"
+ },
+ "GrantaServerApiDataExportDatumsSeries": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsSeriesPoint"
+ },
+ "nullable": true
+ },
+ "graphDecoration": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsGraphDecoration"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsSeriesPoint": {
+ "type": "object",
+ "properties": {
+ "x": {
+ "type": "number",
+ "format": "double"
+ },
+ "xName": {
+ "type": "string",
+ "nullable": true
+ },
+ "yLow": {
+ "type": "number",
+ "format": "double"
+ },
+ "yHigh": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsShortTextDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "datumValue": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiDataExportDatumsTabularDatum": {
+ "required": [
+ "linkDatumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsLinkDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeName": {
+ "type": "string",
+ "nullable": true
+ },
+ "tabularRows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsTabularRow"
+ },
+ "nullable": true
+ },
+ "summaryRow": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ "nullable": true
+ },
+ "linkDatumType": {
+ "type": "string",
+ "default": "tabular"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsLinkDatum",
+ "x-discriminator-value": "tabular"
+ },
+ "GrantaServerApiDataExportDatumsTabularRow": {
+ "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/GrantaServerApiDataExportDatumsDatum"
+ },
+ "nullable": true
+ },
+ "linkedRecords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportRecordReference"
+ },
+ "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/GrantaServerApiDataExportRecordWithData"
+ },
+ "description": "Data for the linked records, if the request included linked data to export",
+ "nullable": true
+ },
+ "rolledUpData": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsUnknownDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "notApplicable": {
+ "type": "string",
+ "default": "unknown"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDatum",
+ "x-discriminator-value": "unknown"
+ },
+ "GrantaServerApiDataExportExportFailuresAttributeExportFailure": {
+ "required": [
+ "failedAttributes",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresAttributeReference"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiDataExportExportFailuresAttributeReference": {
+ "required": [
+ "databaseKey"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true,
+ "readOnly": true
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true,
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportExportFailuresDatumExportFailure": {
+ "required": [
+ "failedDatum",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedDatum": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresDatumReference"
+ },
+ "type": {
+ "type": "string",
+ "default": "datum"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "datum"
+ },
+ "GrantaServerApiDataExportExportFailuresDatumReference": {
+ "required": [
+ "attributeIdentity",
+ "databaseKey",
+ "recordHistoryIdentity"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportExportFailuresExportFailure": {
+ "required": [
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "failureDetails": {
+ "type": "string"
+ },
+ "failureReason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportExportFailuresRecordExportFailure\r\n * GrantaServerApiDataExportExportFailuresLinkExportFailure\r\n * GrantaServerApiDataExportExportFailuresAttributeExportFailure\r\n * GrantaServerApiDataExportExportFailuresDatumExportFailure\r\n * GrantaServerApiDataExportExportFailuresRollupExportFailure",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "record": "#/components/schemas/GrantaServerApiDataExportExportFailuresRecordExportFailure",
+ "link": "#/components/schemas/GrantaServerApiDataExportExportFailuresLinkExportFailure",
+ "attribute": "#/components/schemas/GrantaServerApiDataExportExportFailuresAttributeExportFailure",
+ "datum": "#/components/schemas/GrantaServerApiDataExportExportFailuresDatumExportFailure",
+ "rollup": "#/components/schemas/GrantaServerApiDataExportExportFailuresRollupExportFailure"
+ }
+ }
+ },
+ "GrantaServerApiDataExportExportFailuresExportFailureType": {
+ "enum": [
+ "record",
+ "link",
+ "attribute",
+ "datum",
+ "rollup"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiDataExportExportFailuresLinkExportFailure": {
+ "required": [
+ "failedLink",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedLink": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresLinkReference"
+ },
+ "type": {
+ "type": "string",
+ "default": "link"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiDataExportExportFailuresLinkReference": {
+ "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/GrantaServerApiLinkAttributeType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportExportFailuresRecordExportFailure": {
+ "required": [
+ "failedRecords",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedRecords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportRecordReference"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "record"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "record"
+ },
+ "GrantaServerApiDataExportExportFailuresRollupExportFailure": {
+ "required": [
+ "failedRollup",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedRollup": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresRollupReference"
+ },
+ "type": {
+ "type": "string",
+ "default": "rollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "rollup"
+ },
+ "GrantaServerApiDataExportExportFailuresRollupReference": {
+ "required": [
+ "databaseKey",
+ "rollupType"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "rollupType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportLinkAttributeToExport": {
+ "required": [
+ "attributeType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localData": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportSimpleAttributeToExport"
+ },
+ "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": {
+ "type": "string",
+ "description": "For tabular searching: this is the identifier of the short-text linking attribute.\r\nOtherwise null.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "attributeType": {
+ "type": "string",
+ "default": "link"
+ },
+ "linkAttributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "exportInReversedDirection": {
+ "type": "boolean"
+ },
+ "recordProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordProperty"
+ },
+ "description": "The properties to export on any linked records.",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ "description": "The attributes to export on any linked records.",
+ "nullable": true
+ },
+ "linkedRecordsExportBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportLinkedRecordExportBehavior"
+ },
+ "indirectLinksBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiIndirectLinks"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Export request information for a 'link' attribute.\r\n\r\nThis extends: GrantaServerApiDataExportAttributeToExport",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiDataExportLinkedRecordExportBehavior": {
+ "type": "object",
+ "properties": {
+ "tabularRowBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportTabularRowExportBehaviour"
+ },
+ "summaryRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "linkedRecordsCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiDataExportParameterSettingDefinedAt": {
+ "enum": [
+ "parameter",
+ "attribute",
+ "datum"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiDataExportPropertiesCreatedByUserProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "createdByUser"
+ },
+ "createdByUser": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "createdByUser"
+ },
+ "GrantaServerApiDataExportPropertiesCreatedDateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "createdDate"
+ },
+ "createdDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "createdDate"
+ },
+ "GrantaServerApiDataExportPropertiesDatabaseKeyProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "databaseKey"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "databaseKey"
+ },
+ "GrantaServerApiDataExportPropertiesFullNameProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "fullName"
+ },
+ "fullName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "fullName"
+ },
+ "GrantaServerApiDataExportPropertiesLastModifiedByUserProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "lastModifiedByUser"
+ },
+ "lastModifiedByUser": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "lastModifiedByUser"
+ },
+ "GrantaServerApiDataExportPropertiesLastModifiedDateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "lastModifiedDate"
+ },
+ "lastModifiedDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "lastModifiedDate"
+ },
+ "GrantaServerApiDataExportPropertiesProperty": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportPropertiesCreatedByUserProperty\r\n * GrantaServerApiDataExportPropertiesCreatedDateProperty\r\n * GrantaServerApiDataExportPropertiesDatabaseKeyProperty\r\n * GrantaServerApiDataExportPropertiesFullNameProperty\r\n * GrantaServerApiDataExportPropertiesLastModifiedDateProperty\r\n * GrantaServerApiDataExportPropertiesLastModifiedByUserProperty\r\n * GrantaServerApiDataExportPropertiesRecordColorProperty\r\n * GrantaServerApiDataExportPropertiesRecordGuidProperty\r\n * GrantaServerApiDataExportPropertiesRecordIdentityProperty\r\n * GrantaServerApiDataExportPropertiesRecordHistoryGuidProperty\r\n * GrantaServerApiDataExportPropertiesRecordHistoryIdentityProperty\r\n * GrantaServerApiDataExportPropertiesRecordTypeProperty\r\n * GrantaServerApiDataExportPropertiesReleasedDateProperty\r\n * GrantaServerApiDataExportPropertiesShortNameProperty\r\n * GrantaServerApiDataExportPropertiesTableGuidProperty\r\n * GrantaServerApiDataExportPropertiesTableIdentityProperty\r\n * GrantaServerApiDataExportPropertiesTableNameProperty\r\n * GrantaServerApiDataExportPropertiesVersionNumberProperty\r\n * GrantaServerApiDataExportPropertiesVersionStateProperty",
+ "discriminator": {
+ "propertyName": "propertyName",
+ "mapping": {
+ "createdByUser": "#/components/schemas/GrantaServerApiDataExportPropertiesCreatedByUserProperty",
+ "createdDate": "#/components/schemas/GrantaServerApiDataExportPropertiesCreatedDateProperty",
+ "databaseKey": "#/components/schemas/GrantaServerApiDataExportPropertiesDatabaseKeyProperty",
+ "fullName": "#/components/schemas/GrantaServerApiDataExportPropertiesFullNameProperty",
+ "lastModifiedDate": "#/components/schemas/GrantaServerApiDataExportPropertiesLastModifiedDateProperty",
+ "lastModifiedByUser": "#/components/schemas/GrantaServerApiDataExportPropertiesLastModifiedByUserProperty",
+ "recordColor": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordColorProperty",
+ "recordGuid": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordGuidProperty",
+ "recordIdentity": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordIdentityProperty",
+ "recordHistoryGuid": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordHistoryGuidProperty",
+ "recordHistoryIdentity": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordHistoryIdentityProperty",
+ "recordType": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordTypeProperty",
+ "releasedDate": "#/components/schemas/GrantaServerApiDataExportPropertiesReleasedDateProperty",
+ "shortName": "#/components/schemas/GrantaServerApiDataExportPropertiesShortNameProperty",
+ "tableGuid": "#/components/schemas/GrantaServerApiDataExportPropertiesTableGuidProperty",
+ "tableIdentity": "#/components/schemas/GrantaServerApiDataExportPropertiesTableIdentityProperty",
+ "tableName": "#/components/schemas/GrantaServerApiDataExportPropertiesTableNameProperty",
+ "versionNumber": "#/components/schemas/GrantaServerApiDataExportPropertiesVersionNumberProperty",
+ "versionState": "#/components/schemas/GrantaServerApiDataExportPropertiesVersionStateProperty"
+ }
+ }
+ },
+ "GrantaServerApiDataExportPropertiesRecordColorProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordColor"
+ },
+ "recordColor": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordColor"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordColor"
+ },
+ "GrantaServerApiDataExportPropertiesRecordGuidProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordGuid"
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordGuid"
+ },
+ "GrantaServerApiDataExportPropertiesRecordHistoryGuidProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordHistoryGuid"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordHistoryGuid"
+ },
+ "GrantaServerApiDataExportPropertiesRecordHistoryIdentityProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordHistoryIdentity"
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordHistoryIdentity"
+ },
+ "GrantaServerApiDataExportPropertiesRecordIdentityProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordIdentity"
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordIdentity"
+ },
+ "GrantaServerApiDataExportPropertiesRecordTypeProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordType"
+ },
+ "recordType": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordType"
+ },
+ "GrantaServerApiDataExportPropertiesReleasedDateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "releasedDate"
+ },
+ "releasedDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "releasedDate"
+ },
+ "GrantaServerApiDataExportPropertiesShortNameProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "shortName"
+ },
+ "shortName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "shortName"
+ },
+ "GrantaServerApiDataExportPropertiesTableGuidProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "tableGuid"
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "tableGuid"
+ },
+ "GrantaServerApiDataExportPropertiesTableIdentityProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "tableIdentity"
+ },
+ "tableIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "tableIdentity"
+ },
+ "GrantaServerApiDataExportPropertiesTableNameProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "tableName"
+ },
+ "tableName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "tableName"
+ },
+ "GrantaServerApiDataExportPropertiesVersionNumberProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "versionNumber"
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "versionNumber"
+ },
+ "GrantaServerApiDataExportPropertiesVersionStateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "versionState"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "versionState"
+ },
+ "GrantaServerApiDataExportRecordWithData": {
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ "nullable": true
+ },
+ "properties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportSimpleAttributeToExport": {
+ "required": [
+ "attributeType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "attributeType": {
+ "type": "string",
+ "default": "simple"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportAttributeToExport",
+ "x-discriminator-value": "simple"
+ },
+ "GrantaServerApiDataExportTabularRowExportBehaviour": {
+ "enum": [
+ "allRows",
+ "onlyRowsWithVisibleLinkedRecords"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiDiscreteValue": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "order": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDiskStatus": {
+ "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"
+ },
+ "GrantaServerApiExceptionsAttributeDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsConstantDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDiscreteTypeDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDiscreteValueDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsErrorDetail": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsParameterDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsParameterValueDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsTableDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExcludeValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "excludedIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "excludedGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "filterOn": {
+ "type": "string",
+ "default": "exclude"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "exclude"
+ },
+ "GrantaServerApiFunctionalDatumParameterInfo": {
+ "type": "object",
+ "properties": {
+ "scaleTypeDefinedAt": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportParameterSettingDefinedAt"
+ },
+ "interpolationMethodDefinedAt": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportParameterSettingDefinedAt"
+ },
+ "defaultValueDefinedAt": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportParameterSettingDefinedAt"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIndexRecordFailure": {
+ "type": "object",
+ "properties": {
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "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": "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."
+ },
+ "GrantaServerApiIndirectLinks": {
+ "enum": [
+ "fromLinkDefinition",
+ "include",
+ "exclude"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiIntegrationDataExportIntegrationDataExportRequest": {
+ "required": [
+ "attributeIdentities",
+ "recordReferences"
+ ],
+ "type": "object",
+ "properties": {
+ "recordReferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportRecordReference"
+ },
+ "description": "A list of records to export. These are references to the underlying records in the source database"
+ },
+ "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
+ },
+ "GrantaServerApiIntegrationDataExportRecordReference": {
+ "type": "object",
+ "properties": {
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "The unique way to identify a record history (which may have multiple versions) in an MI system"
+ },
+ "GrantaServerApiIntegrationIntegrationSchemaStatus": {
+ "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
+ },
+ "erroredDatabases": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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/GrantaServerApiSearchIndexStatus"
+ },
+ "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,
+ "readOnly": 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
+ },
+ "diskStatus": {
+ "$ref": "#/components/schemas/GrantaServerApiDiskStatus"
+ },
+ "diskThreshold": {
+ "type": "string",
+ "description": "The 'flood stage' threshold from Elasticsearch.",
+ "nullable": true
+ },
+ "searchIndexUnavailable": {
+ "type": "boolean",
+ "description": "True if the index could not be contacted.",
+ "nullable": true
+ },
+ "recordsThatFailedToIndex": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIndexRecordFailure"
+ },
+ "description": "Details of any records that failed to index.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
+ "type": "string",
+ "description": "Set as nullable for older schema compatibility,\r\nbut we expect it to be set almost everywhere,\r\nexcept during loading from disk.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "description": "If isUnitted is true, then this must have a non empty value",
+ "nullable": true
+ },
+ "isUnitted": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "discreteTypeIdentity": {
+ "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/GrantaServerApiIntegrationSchemaIntegrationParameterInfo"
+ },
+ "description": "A float functional attribute must define a list of parameters.",
+ "nullable": true
+ },
+ "targetDatabase": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "targetTable": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaDiscreteType": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "unitSymbol": {
+ "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
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationParameterInfo"
+ },
+ "description": "A float functional attribute must define a list of parameters.",
+ "nullable": true
+ },
+ "targetDatabase": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "targetTable": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyDiscreteType": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationParameterInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "nullable": true
+ },
+ "version": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyAttribute"
+ },
+ "nullable": true
+ },
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyLayout"
+ },
+ "nullable": true
+ },
+ "unitSystem": {
+ "type": "string",
+ "nullable": true
+ },
+ "discreteTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyDiscreteType"
+ },
+ "nullable": true
+ },
+ "sources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlySourceOfGrantaServerApiObjectIdentifier"
+ },
+ "nullable": true
+ },
+ "accessControlCategoryValues": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "securityGroups": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSecurityGroups"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Similar to IntegrationSchema, but without identities.\r\nUsed when we don't want consumers to specify/know about identities."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyMappingOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "targetGuid": {
+ "type": "string",
+ "description": "The guid of the integration schema attribute",
+ "format": "uuid"
+ },
+ "parameterMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "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/GrantaServerApiIntegrationSchemaLinkSourceType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A mapping between a source database item and an integration schema attribute."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlySourceOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "database": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "mappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "description": "Mappings for items from this table to the integration schema attributes.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "A source table from which integrated data will be taken."
+ },
+ "GrantaServerApiIntegrationSchemaIntegrationParameterInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "nullable": true
+ },
+ "version": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ },
+ "nullable": true
+ },
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaLayout"
+ },
+ "nullable": true
+ },
+ "unitSystem": {
+ "type": "string",
+ "nullable": true
+ },
+ "discreteTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaDiscreteType"
+ },
+ "nullable": true
+ },
+ "sources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ },
+ "nullable": true
+ },
+ "accessControlCategoryValues": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "securityGroups": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSecurityGroups"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaLinkSourceType": {
+ "enum": [
+ "recordLink",
+ "crossDatabaseLink",
+ "reverseCrossDatabaseLink"
+ ],
+ "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"
+ },
+ "GrantaServerApiIntegrationSchemaMappingOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "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",
+ "nullable": true
+ },
+ "parameterMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "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/GrantaServerApiIntegrationSchemaLinkSourceType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A mapping between a source database item and an integration schema attribute."
+ },
+ "GrantaServerApiIntegrationSchemaSecurityGroups": {
+ "type": "object",
+ "properties": {
+ "readGroup": {
+ "type": "string",
+ "description": "Members of this groups can read data from the integration schema.",
+ "nullable": true
+ },
+ "adminGroup": {
+ "type": "string",
+ "description": "Members of this group can perform administrative tasks such as adding or deleting the schema.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "The security groups that apply to an integration schema. If null or empty, the default MI security groups will be used."
+ },
+ "GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "database": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "mappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "description": "Mappings for items from this table to the integration schema attributes.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "A source table from which integrated data will be taken."
+ },
+ "GrantaServerApiLinkAttributeType": {
+ "enum": [
+ "recordLink",
+ "crossDatabaseLink",
+ "dynamicLink",
+ "tabularAttribute"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiListsDtoListBooleanCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "matchAny": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ "nullable": true
+ },
+ "matchAll": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "listBoolean"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiListsDtoListCriterion",
+ "x-discriminator-value": "listBoolean"
+ },
+ "GrantaServerApiListsDtoListCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiListsDtoListBooleanCriterion\r\n * GrantaServerApiListsDtoRecordListSearchCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "listBoolean": "#/components/schemas/GrantaServerApiListsDtoListBooleanCriterion",
+ "recordList": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchCriterion"
+ }
+ }
+ },
+ "GrantaServerApiListsDtoListItem": {
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordVersion": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoPagingOptions": {
+ "type": "object",
+ "properties": {
+ "startIndex": {
+ "type": "integer",
+ "description": "The index of the first list in the collection to be returned. If not provided it will start at index 0.",
+ "format": "int32",
+ "nullable": true
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The number of lists to be returned per page. If not provided the number of returned lists will be unlimited.",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListCreate": {
+ "type": "object",
+ "properties": {
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItems"
+ },
+ "identifier": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "published": {
+ "type": "boolean"
+ },
+ "awaitingApproval": {
+ "type": "boolean"
+ },
+ "internalUse": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListHeader": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "nullable": true
+ },
+ "parentRecordListIdentifier": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdUser": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserOrGroup"
+ },
+ "lastModifiedTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedUser": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserOrGroup"
+ },
+ "publishedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "publishedUser": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserOrGroup"
+ },
+ "isRevision": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "published": {
+ "type": "boolean"
+ },
+ "awaitingApproval": {
+ "type": "boolean"
+ },
+ "internalUse": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListItems": {
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListItem"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListPermissionFlagsDto": {
+ "type": "object",
+ "properties": {
+ "isOwner": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an owner of this list.\r\nNull means: do not change this flag's value when inserting into database.",
+ "nullable": true
+ },
+ "isSubscribed": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is subscribed to this list.\r\nNull means: do not change this flag's value when inserting into database.",
+ "nullable": true
+ },
+ "isCurator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is a curator of this list.\r\nNull means: do not change this flag's value when inserting into database.",
+ "nullable": true
+ },
+ "isAdministrator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an administrator of this list.\r\nNull means: do not change this flag's value when inserting into database.",
+ "nullable": true
+ },
+ "isPublisher": {
+ "type": "boolean",
+ "description": "Flag indicating if this user or group is a publisher of this list.\r\nNull means: do not change this flag's value when inserting into database.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListProperties": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "published": {
+ "type": "boolean"
+ },
+ "awaitingApproval": {
+ "type": "boolean"
+ },
+ "internalUse": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListSearchCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "nameContains": {
+ "type": "string",
+ "nullable": true
+ },
+ "userRole": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserRole"
+ },
+ "isPublished": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isAwaitingApproval": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isInternalUse": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isRevision": {
+ "type": "boolean",
+ "description": "Restrict to record lists that are (non discarded) revisions.",
+ "nullable": true
+ },
+ "containsRecordsInDatabases": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing records in any of of the specified databases",
+ "nullable": true
+ },
+ "containsRecordsInIntegrationSchemas": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Limits results to lists containing records in any of the specified integration schemas",
+ "nullable": true
+ },
+ "containsRecordsInTables": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing records in any of the specified tables",
+ "nullable": true
+ },
+ "containsRecords": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing any of the given records",
+ "nullable": true
+ },
+ "userCanAddOrRemoveItems": {
+ "type": "boolean",
+ "description": "Limits results to lists where the current user can add or remove items.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordList"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiListsDtoListCriterion",
+ "x-discriminator-value": "recordList"
+ },
+ "GrantaServerApiListsDtoRecordListSearchInfo": {
+ "type": "object",
+ "properties": {
+ "searchResultIdentifier": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListSearchRequest": {
+ "type": "object",
+ "properties": {
+ "searchCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ "pagingOptions": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoPagingOptions"
+ },
+ "responseOptions": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoResponseOptions"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListSearchResult": {
+ "type": "object",
+ "properties": {
+ "header": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListItem"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoResponseOptions": {
+ "type": "object",
+ "properties": {
+ "includeUserActions": {
+ "type": "boolean"
+ },
+ "includeUserPermissions": {
+ "type": "boolean"
+ },
+ "includeRecordListItems": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserOrGroup": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayName": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserPermissionDto": {
+ "type": "object",
+ "properties": {
+ "userOrGroupName": {
+ "type": "string",
+ "description": "The user or group name.",
+ "nullable": true
+ },
+ "userOrGroupIdentifier": {
+ "type": "string",
+ "description": "The user or group identifier",
+ "format": "uuid"
+ },
+ "flags": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserPermissionInputDto": {
+ "type": "object",
+ "properties": {
+ "userOrGroupIdentifier": {
+ "type": "string",
+ "description": "The user or group identifier",
+ "format": "uuid"
+ },
+ "flags": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlagsDto"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserRole": {
+ "enum": [
+ "None",
+ "Owner",
+ "Subscriber",
+ "Curator",
+ "Administrator",
+ "Publisher"
+ ],
+ "type": "string",
+ "description": "A set of flags that can be used to describe the role or roles that a user has on a particular record list"
+ },
+ "GrantaServerApiNoValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filterOn": {
+ "type": "string",
+ "default": "none"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Used to return no values.\r\n\r\nThis extends: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "none"
+ },
+ "GrantaServerApiObjectIdentifier": {
+ "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."
+ },
+ "GrantaServerApiParameterInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiParameterInfoInterpolationType": {
+ "enum": [
+ "auto",
+ "none",
+ "linear",
+ "cubicSpline"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiParameterInfoParameterType": {
+ "enum": [
+ "discrete",
+ "numericRestricted",
+ "numericUnrestricted"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiParameterInfoScaleType": {
+ "enum": [
+ "notSet",
+ "linear",
+ "log"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiRecordColor": {
+ "enum": [
+ "red",
+ "lime",
+ "blue",
+ "yellow",
+ "fuchsia",
+ "aqua",
+ "maroon",
+ "green",
+ "navy",
+ "olive",
+ "purple",
+ "teal",
+ "gray",
+ "black",
+ "white",
+ "silver"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the supported record colors."
+ },
+ "GrantaServerApiRecordProperty": {
+ "enum": [
+ "recordIdentity",
+ "recordGuid",
+ "recordHistoryIdentity",
+ "recordHistoryGuid",
+ "tableIdentity",
+ "tableGuid",
+ "tableName",
+ "databaseKey",
+ "createdByUser",
+ "createdDate",
+ "lastModifiedByUser",
+ "lastModifiedDate",
+ "recordType",
+ "versionState",
+ "versionNumber",
+ "releasedDate",
+ "fullName",
+ "shortName",
+ "recordColor"
+ ],
+ "type": "string",
+ "description": "A record property represents data on a record that typically cannot be independently edited,\r\nas opposed to attribute data which may be edited on a record freely (albeit possibly requiring\r\nreleasing a new version). Record properties are usually tracked by the system automatically\r\nand are usually read-only.\r\nNote: for legacy reasons, some 'record properties' do not fall into these criteria, and do\r\nrepresent editable record fields more similar to attribute data. These record properties are\r\nusually exposed in this API as both 'record properties' and 'pseudo-attributes'."
+ },
+ "GrantaServerApiRecordType": {
+ "enum": [
+ "record",
+ "generic",
+ "folder"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the supported record types."
+ },
+ "GrantaServerApiRecordsRecordHistoriesRecordHistory": {
+ "required": [
+ "guid",
+ "isFolder",
+ "recordVersions",
+ "table"
+ ],
+ "type": "object",
+ "properties": {
+ "isFolder": {
+ "type": "boolean"
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimTable"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesSlimRecordHistory"
+ },
+ "recordVersions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordVersionsSlimRecordVersion"
+ }
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordHistoriesSlimRecordHistory": {
+ "required": [
+ "guid"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordVersionsRecordVersion": {
+ "required": [
+ "createdByUser",
+ "createdDate",
+ "databaseKey",
+ "guid",
+ "lastModifiedByUser",
+ "lastModifiedDate",
+ "name",
+ "recordColor",
+ "recordHistory",
+ "recordType",
+ "shortName",
+ "table",
+ "versionNumber",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "recordHistory": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesSlimRecordHistory"
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimTable"
+ },
+ "databaseKey": {
+ "type": "string"
+ },
+ "createdByUser": {
+ "type": "string"
+ },
+ "createdDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedByUser": {
+ "type": "string"
+ },
+ "lastModifiedDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "recordType": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordType"
+ },
+ "releasedDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "shortName": {
+ "type": "string"
+ },
+ "recordColor": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordColor"
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordVersionsSlimRecordVersion": {
+ "required": [
+ "guid",
+ "name",
+ "versionNumber",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "info": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute+AttributeInfo"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaAttributesPointAttribute\r\n * GrantaServerApiSchemaAttributesIntegerAttribute\r\n * GrantaServerApiSchemaAttributesRangeAttribute\r\n * GrantaServerApiSchemaAttributesLogicalAttribute\r\n * GrantaServerApiSchemaAttributesShortTextAttribute\r\n * GrantaServerApiSchemaAttributesLongTextAttribute\r\n * GrantaServerApiSchemaAttributesDateTimeAttribute\r\n * GrantaServerApiSchemaAttributesDiscreteAttribute\r\n * GrantaServerApiSchemaAttributesHyperlinkAttribute\r\n * GrantaServerApiSchemaAttributesFileAttribute\r\n * GrantaServerApiSchemaAttributesPictureAttribute\r\n * GrantaServerApiSchemaAttributesTabularAttribute\r\n * GrantaServerApiSchemaAttributesFloatFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesDiscreteFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesMathsFunctionalAttribute",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "point": "#/components/schemas/GrantaServerApiSchemaAttributesPointAttribute",
+ "integer": "#/components/schemas/GrantaServerApiSchemaAttributesIntegerAttribute",
+ "range": "#/components/schemas/GrantaServerApiSchemaAttributesRangeAttribute",
+ "logical": "#/components/schemas/GrantaServerApiSchemaAttributesLogicalAttribute",
+ "shortText": "#/components/schemas/GrantaServerApiSchemaAttributesShortTextAttribute",
+ "longText": "#/components/schemas/GrantaServerApiSchemaAttributesLongTextAttribute",
+ "dateTime": "#/components/schemas/GrantaServerApiSchemaAttributesDateTimeAttribute",
+ "discrete": "#/components/schemas/GrantaServerApiSchemaAttributesDiscreteAttribute",
+ "hyperlink": "#/components/schemas/GrantaServerApiSchemaAttributesHyperlinkAttribute",
+ "file": "#/components/schemas/GrantaServerApiSchemaAttributesFileAttribute",
+ "picture": "#/components/schemas/GrantaServerApiSchemaAttributesPictureAttribute",
+ "link": "#/components/schemas/GrantaServerApiSchemaAttributesTabularAttribute",
+ "floatFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesFloatFunctionalAttribute",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesDiscreteFunctionalAttribute",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesMathsFunctionalAttribute"
+ }
+ }
+ },
+ "GrantaServerApiSchemaAttributesAttribute+AttributeInfo": {
+ "required": [
+ "chartable",
+ "expressionable",
+ "extendedName",
+ "foreignDataLinkGroups",
+ "isMetaAttribute",
+ "linkable",
+ "primaryDataLinkGroups",
+ "standardNames",
+ "typeCode"
+ ],
+ "type": "object",
+ "properties": {
+ "typeCode": {
+ "type": "string"
+ },
+ "chartable": {
+ "type": "boolean"
+ },
+ "expressionable": {
+ "type": "boolean"
+ },
+ "linkable": {
+ "type": "boolean"
+ },
+ "extendedName": {
+ "type": "string"
+ },
+ "isMetaAttribute": {
+ "type": "boolean"
+ },
+ "orderedMetaAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "standardNames": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "primaryDataLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "foreignDataLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "primaryDynamicLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "foreignDynamicLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesAttributeInterpolationMethod": {
+ "enum": [
+ "auto",
+ "none",
+ "linear",
+ "cubicSpline"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaAttributesAttributeScaleType": {
+ "enum": [
+ "notSet",
+ "linear",
+ "logarithmic"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaAttributesAttributeThresholdType": {
+ "enum": [
+ "exists",
+ "doesNotExist",
+ "atLeast",
+ "atMost",
+ "equal",
+ "between",
+ "isOneOf",
+ "contains",
+ "isNot",
+ "isAllOf",
+ "none"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaAttributesAttributeValidateResponse": {
+ "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
+ },
+ "GrantaServerApiSchemaAttributesAttributesInfo": {
+ "required": [
+ "attributes"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaAttributesCreateAttributesCreatePointAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateIntegerAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateRangeAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateLogicalAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateShortTextAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateLongTextAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateDateTimeAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateHyperlinkAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateFileAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreatePictureAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateTabularAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateMathsFunctionalAttribute",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "point": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreatePointAttribute",
+ "integer": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateIntegerAttribute",
+ "range": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateRangeAttribute",
+ "logical": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateLogicalAttribute",
+ "shortText": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateShortTextAttribute",
+ "longText": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateLongTextAttribute",
+ "dateTime": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDateTimeAttribute",
+ "discrete": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteAttribute",
+ "hyperlink": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateHyperlinkAttribute",
+ "file": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateFileAttribute",
+ "picture": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreatePictureAttribute",
+ "link": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateTabularAttribute",
+ "floatFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttribute",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttribute",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateMathsFunctionalAttribute"
+ }
+ }
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDateTimeAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteAttribute": {
+ "required": [
+ "discreteType",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "discreteType",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttributeParameter": {
+ "required": [
+ "parameter"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateFileAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttributeParameter": {
+ "required": [
+ "parameter"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeScaleType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateHyperlinkAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateIntegerAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateLogicalAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateLongTextAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateMathsFunctionalAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "allowExtrapolation": {
+ "type": "boolean"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreatePictureAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreatePointAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateRangeAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateShortTextAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateTabularAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ "nullable": true
+ },
+ "target": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesTabularAttributeTarget"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaAttributesDateTimeAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSchemaAttributesDiscreteAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "discreteType",
+ "displayNames",
+ "guid",
+ "info",
+ "isMultiValued",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaAttributesDiscreteFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "defaultThresholdType",
+ "discreteType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiSchemaAttributesDiscreteFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesFileAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSchemaAttributesFloatFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isRange",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiSchemaAttributesFloatFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeScaleType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesHyperlinkAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSchemaAttributesIntegerAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isUnique",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSchemaAttributesLogicalAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSchemaAttributesLongTextAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSchemaAttributesMathsContent": {
+ "required": [
+ "parameterContents",
+ "transposeAxes",
+ "useLogarithmicScale"
+ ],
+ "type": "object",
+ "properties": {
+ "curveLabel": {
+ "type": "string",
+ "nullable": true
+ },
+ "transposeAxes": {
+ "type": "boolean"
+ },
+ "useLogarithmicScale": {
+ "type": "boolean"
+ },
+ "expression": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimExpression"
+ },
+ "freeParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "parameterContents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterContent"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesMathsFunctionalAttribute": {
+ "required": [
+ "allowAllCompatibleExpressions",
+ "allowAnonymousExpressions",
+ "allowExtrapolation",
+ "attributeParameters",
+ "defaultContent",
+ "defaultThresholdType",
+ "displayNames",
+ "expressions",
+ "guid",
+ "info",
+ "isRange",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimExpression"
+ }
+ },
+ "allowExtrapolation": {
+ "type": "boolean"
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "type": "boolean"
+ },
+ "defaultContent": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesMathsContent"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSchemaAttributesPictureAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSchemaAttributesPointAttribute": {
+ "required": [
+ "attributeParameters",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isMultiValued",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSchemaAttributesRangeAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSchemaAttributesShortTextAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isUnique",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSchemaAttributesTabularAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayFullTable",
+ "displayNames",
+ "displaySummaryRowInline",
+ "guid",
+ "hideUnlinkedRows",
+ "info",
+ "name",
+ "tabularColumns",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesTabularAttributeTarget"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaAttributesTabularAttributeTarget": {
+ "type": "object",
+ "properties": {
+ "targetDatabaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetDatabaseVersionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetTableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetAttributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdatePointAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateIntegerAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateRangeAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateLogicalAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateShortTextAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateLongTextAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateDateTimeAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateHyperlinkAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateFileAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdatePictureAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateTabularAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsFunctionalAttribute",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "point": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdatePointAttribute",
+ "integer": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateIntegerAttribute",
+ "range": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateRangeAttribute",
+ "logical": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateLogicalAttribute",
+ "shortText": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateShortTextAttribute",
+ "longText": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateLongTextAttribute",
+ "dateTime": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDateTimeAttribute",
+ "discrete": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteAttribute",
+ "hyperlink": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateHyperlinkAttribute",
+ "file": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateFileAttribute",
+ "picture": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdatePictureAttribute",
+ "link": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateTabularAttribute",
+ "floatFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttribute",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttribute",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsFunctionalAttribute"
+ }
+ }
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDateTimeAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateFileAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameterGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeScaleType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateHyperlinkAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateIntegerAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateLogicalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateLongTextAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsContent": {
+ "type": "object",
+ "properties": {
+ "curveLabel": {
+ "type": "string",
+ "nullable": true
+ },
+ "transposeAxes": {
+ "type": "boolean"
+ },
+ "useLogarithmicScale": {
+ "type": "boolean"
+ },
+ "expression": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "freeParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "parameterContents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterContent"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsFunctionalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "allowExtrapolation": {
+ "type": "boolean"
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "defaultContent": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsContent"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdatePictureAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdatePointAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateRangeAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateShortTextAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateTabularAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaAttributesValidateAttributeRequest": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The value to check an attributes data validation rules against",
+ "nullable": true
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "description": "The record you want to check the value against to see if the value has changed as well as being valid",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConfigurationsConfiguration": {
+ "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
+ },
+ "GrantaServerApiSchemaConfigurationsConfigurationsInfo": {
+ "required": [
+ "configurations"
+ ],
+ "type": "object",
+ "properties": {
+ "configurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimConfiguration"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConfigurationsCreateConfiguration": {
+ "required": [
+ "name",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConfigurationsUpdateConfiguration": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConstantsConstant": {
+ "required": [
+ "guid",
+ "name",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Constant used in equations"
+ },
+ "GrantaServerApiSchemaConstantsConstantsInfo": {
+ "type": "object",
+ "properties": {
+ "constants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimConstant"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConstantsCreateConstant": {
+ "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
+ },
+ "GrantaServerApiSchemaConstantsUpdateConstant": {
+ "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
+ },
+ "GrantaServerApiSchemaDataRulesCreateDataRule": {
+ "required": [
+ "description",
+ "name",
+ "regularExpression"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDataRulesDataRule": {
+ "required": [
+ "description",
+ "guid",
+ "name",
+ "regularExpression",
+ "usedByAttributes"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "usedByAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDataRulesDataRulesInfo": {
+ "type": "object",
+ "properties": {
+ "dataRules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDataRulesUpdateDataRule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDatabase": {
+ "required": [
+ "guid",
+ "isLocked",
+ "isReadOnly",
+ "key",
+ "name",
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "string",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "currencyCode": {
+ "type": "string",
+ "nullable": true
+ },
+ "isAccessControlled": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "key": {
+ "type": "string"
+ },
+ "versionGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabaseStatus"
+ },
+ "isReadOnly": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "indexInSync": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "indexUpToDate": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "indexOutOfDateDuration": {
+ "type": "string",
+ "format": "date-span",
+ "nullable": true
+ },
+ "schemaVersion": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDatabaseStatus": {
+ "enum": [
+ "Unknown",
+ "OK",
+ "Unloaded",
+ "Loading",
+ "Unloading",
+ "FailedToLoad",
+ "FailedToUnload",
+ "Disabled"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaDatabasesInfo": {
+ "type": "object",
+ "properties": {
+ "databases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimDatabase"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesCreateDiscreteType": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesDiscreteType": {
+ "required": [
+ "guid",
+ "isOrdered",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesDiscreteTypesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType": {
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue": {
+ "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"
+ },
+ "GrantaServerApiSchemaDiscreteValuesDiscreteValue": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsCreateExpression": {
+ "required": [
+ "name",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsExpression": {
+ "required": [
+ "attributeDependencies",
+ "constantDependencies",
+ "guid",
+ "name",
+ "parameterDependencies",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "attributeDependencies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "constantDependencies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "parameterDependencies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsExpressionsInfo": {
+ "type": "object",
+ "properties": {
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimExpression"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsUpdateExpression": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesCreateFolder": {
+ "required": [
+ "name",
+ "parentGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "parentGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesExporterRefetchInfo": {
+ "type": "object",
+ "properties": {
+ "succeeded": {
+ "type": "boolean"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFileHeader": {
+ "required": [
+ "dataLength",
+ "description",
+ "extension",
+ "folderGuid",
+ "guid",
+ "name",
+ "path"
+ ],
+ "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"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFilesInfo": {
+ "type": "object",
+ "properties": {
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimFile"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFolder": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "parentGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFoldersInfo": {
+ "type": "object",
+ "properties": {
+ "folders": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesMoveFile": {
+ "required": [
+ "folderGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "folderGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesMoveFolder": {
+ "required": [
+ "parentGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "parentGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesUpdateFile": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesUpdateFolder": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsCreateLayout": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Layouts\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "GrantaServerApiSchemaLayoutsCreateLayoutSection": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Layout Sections\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "GrantaServerApiSchemaLayoutsFullLayoutSection": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sectionDetailType",
+ "sectionItems"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sectionDetailType": {
+ "type": "string",
+ "default": "full"
+ },
+ "sectionItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItem"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutSection",
+ "x-discriminator-value": "full"
+ },
+ "GrantaServerApiSchemaLayoutsLayout": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sections"
+ ],
+ "type": "object",
+ "properties": {
+ "sections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsLayoutAttributeItem": {
+ "required": [
+ "attributeType",
+ "guid",
+ "itemType",
+ "name",
+ "readOnly",
+ "required",
+ "underlyingEntityGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "attribute"
+ },
+ "attributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "required": {
+ "type": "boolean"
+ },
+ "readOnly": {
+ "type": "boolean"
+ },
+ "metaAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutAttributeItem"
+ },
+ "nullable": true
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutTabularColumn"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutItem",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSchemaLayoutsLayoutItem": {
+ "required": [
+ "guid",
+ "itemType",
+ "name",
+ "underlyingEntityGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "underlyingEntityGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaLayoutsLayoutAttributeItem\r\n * GrantaServerApiSchemaLayoutsLayoutLinkItem",
+ "discriminator": {
+ "propertyName": "itemType",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutAttributeItem",
+ "link": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutLinkItem"
+ }
+ }
+ },
+ "GrantaServerApiSchemaLayoutsLayoutItemLinkType": {
+ "enum": [
+ "recordLink",
+ "smartLink",
+ "crossDatabaseLink",
+ "associationChain"
+ ],
+ "type": "string",
+ "description": "The types of layout items that represent links to another table."
+ },
+ "GrantaServerApiSchemaLayoutsLayoutItemType": {
+ "enum": [
+ "attribute",
+ "link"
+ ],
+ "type": "string",
+ "description": "The types of layout item that are supported by the API."
+ },
+ "GrantaServerApiSchemaLayoutsLayoutLinkItem": {
+ "required": [
+ "forwards",
+ "guid",
+ "itemType",
+ "linkType",
+ "name",
+ "targetTable",
+ "underlyingEntityGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "link"
+ },
+ "linkType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItemLinkType"
+ },
+ "targetDatabase": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "targetDatabaseVersion": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "targetTable": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "forwards": {
+ "type": "boolean"
+ },
+ "nextLink": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutLinkItem"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutItem",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaLayoutsLayoutSection": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sectionDetailType"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaSlimEntitiesSlimLayoutSection\r\n * GrantaServerApiSchemaLayoutsFullLayoutSection",
+ "discriminator": {
+ "propertyName": "sectionDetailType",
+ "mapping": {
+ "slim": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayoutSection",
+ "full": "#/components/schemas/GrantaServerApiSchemaLayoutsFullLayoutSection"
+ }
+ }
+ },
+ "GrantaServerApiSchemaLayoutsLayoutSectionDetailType": {
+ "enum": [
+ "slim",
+ "full"
+ ],
+ "type": "string",
+ "description": "The types of detail returned for a layout section."
+ },
+ "GrantaServerApiSchemaLayoutsLayoutSectionsInfo": {
+ "type": "object",
+ "properties": {
+ "layoutSections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsLayoutTabularColumn": {
+ "required": [
+ "columnType",
+ "guid",
+ "name",
+ "tabularColumnGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnDtoType"
+ },
+ "tabularColumnGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsLayoutsInfo": {
+ "type": "object",
+ "properties": {
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutAssociationChainItem": {
+ "required": [
+ "associationChainLinks",
+ "associationChainName",
+ "itemType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "associationChain"
+ },
+ "associationChainName": {
+ "type": "string"
+ },
+ "associationChainLinks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAssociationChainLink"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "associationChain"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutAssociationChainLink": {
+ "required": [
+ "sourceDatabaseVersionGuid",
+ "tabularAttributeGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "forwards": {
+ "type": "boolean"
+ },
+ "sourceDatabaseVersionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "tabularAttributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutAttributeItem": {
+ "required": [
+ "attributeGuid",
+ "itemType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "attribute"
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": {
+ "type": "boolean"
+ },
+ "readOnly": {
+ "type": "boolean"
+ },
+ "metaAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAttributeItem"
+ },
+ "nullable": true
+ },
+ "tabularColumnGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutCrossDatabaseLinkItem": {
+ "required": [
+ "itemType",
+ "linkGroupGuid",
+ "sourceDatabaseGuid",
+ "sourceTableGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "crossDatabaseLink"
+ },
+ "sourceDatabaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "sourceTableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "linkGroupGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "crossDatabaseLink"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutItem": {
+ "required": [
+ "itemType"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaLayoutsNewLayoutAttributeItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutRecordLinkItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutSmartLinkItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutCrossDatabaseLinkItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutAssociationChainItem",
+ "discriminator": {
+ "propertyName": "itemType",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAttributeItem",
+ "recordLink": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutRecordLinkItem",
+ "smartLink": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutSmartLinkItem",
+ "crossDatabaseLink": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutCrossDatabaseLinkItem",
+ "associationChain": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAssociationChainItem"
+ }
+ }
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutItemType": {
+ "enum": [
+ "attribute",
+ "recordLink",
+ "smartLink",
+ "crossDatabaseLink",
+ "associationChain"
+ ],
+ "type": "string",
+ "description": "The types of new layout item that are supported by the API."
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutRecordLinkItem": {
+ "required": [
+ "itemType",
+ "linkGroupGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "recordLink"
+ },
+ "linkGroupGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "recordLink"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutSmartLinkItem": {
+ "required": [
+ "itemType",
+ "linkGroupGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "smartLink"
+ },
+ "forwards": {
+ "type": "boolean"
+ },
+ "linkGroupGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "smartLink"
+ },
+ "GrantaServerApiSchemaLayoutsReorderSectionsInfo": {
+ "required": [
+ "layoutSections"
+ ],
+ "type": "object",
+ "properties": {
+ "layoutSections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsUpdateLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersContinuousRange": {
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersCreateDiscreteParameter": {
+ "required": [
+ "defaultParameterValueIndex",
+ "name",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateDiscreteParameterValue"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameter",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersCreateDiscreteParameterValue": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameterValue",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersCreateNumericParameter": {
+ "required": [
+ "defaultParameterValueIndex",
+ "interpolationType",
+ "isRestricted",
+ "name",
+ "scaleType",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "isRestricted": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateNumericParameterValue"
+ }
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameter",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersCreateNumericParameterValue": {
+ "required": [
+ "type",
+ "value"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameterValue",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersCreateParameter": {
+ "required": [
+ "defaultParameterValueIndex",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "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 * GrantaServerApiSchemaParametersCreateDiscreteParameter\r\n * GrantaServerApiSchemaParametersCreateNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersCreateDiscreteParameter",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersCreateNumericParameter"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersCreateParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersCreateDiscreteParameterValue\r\n * GrantaServerApiSchemaParametersCreateNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersCreateDiscreteParameterValue",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersCreateNumericParameterValue"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersDiscreteParameter": {
+ "required": [
+ "defaultParameterValueGuid",
+ "displayNames",
+ "guid",
+ "name",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameterValue"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameter",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersDiscreteParameterContent": {
+ "required": [
+ "parameter",
+ "parameterRange",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "parameterValue": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterContent",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersDiscreteParameterValue": {
+ "required": [
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterValue",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersDiscreteRange": {
+ "required": [
+ "parameterValues"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersNumericParameter": {
+ "required": [
+ "defaultParameterValueGuid",
+ "displayNames",
+ "guid",
+ "interpolationType",
+ "isRestricted",
+ "name",
+ "scaleType",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "isRestricted": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameterValue"
+ }
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameter",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersNumericParameterContent": {
+ "required": [
+ "parameter",
+ "parameterRange",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "value": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersContinuousRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterContent",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersNumericParameterValue": {
+ "required": [
+ "guid",
+ "type",
+ "value"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterValue",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersParameter": {
+ "required": [
+ "defaultParameterValueGuid",
+ "displayNames",
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "defaultParameterValueGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersDiscreteParameter\r\n * GrantaServerApiSchemaParametersNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameter",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameter"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersDiscreteParameterContent\r\n * GrantaServerApiSchemaParametersNumericParameterContent",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameterContent",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameterContent"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersParameterInterpolationType": {
+ "enum": [
+ "none",
+ "linear",
+ "cubicSpline"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParameterScaleType": {
+ "enum": [
+ "linear",
+ "logarithmic"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParameterType": {
+ "enum": [
+ "discrete",
+ "numeric"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParameterValue": {
+ "required": [
+ "guid",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersDiscreteParameterValue\r\n * GrantaServerApiSchemaParametersNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameterValue",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameterValue"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersParameterValueType": {
+ "enum": [
+ "discrete",
+ "numeric"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParametersInfo": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersUpdateContinuousRange": {
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteParameter": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameter",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "parameterValue": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterContent",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterValue",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteRange": {
+ "required": [
+ "parameterValues"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersUpdateNumericParameter": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameter",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersUpdateNumericParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "value": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateContinuousRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterContent",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersUpdateNumericParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterValue",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersUpdateParameter": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "defaultParameterValueGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersUpdateDiscreteParameter\r\n * GrantaServerApiSchemaParametersUpdateNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteParameter",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersUpdateNumericParameter"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersUpdateParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersUpdateDiscreteParameterContent\r\n * GrantaServerApiSchemaParametersUpdateNumericParameterContent",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteParameterContent",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersUpdateNumericParameterContent"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersUpdateParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersUpdateDiscreteParameterValue\r\n * GrantaServerApiSchemaParametersUpdateNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteParameterValue",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersUpdateNumericParameterValue"
+ }
+ }
+ },
+ "GrantaServerApiSchemaProfileTablesCreateProfileTable": {
+ "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
+ },
+ "GrantaServerApiSchemaProfileTablesProfileTable": {
+ "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."
+ },
+ "GrantaServerApiSchemaProfileTablesProfileTablesInfo": {
+ "type": "object",
+ "properties": {
+ "profileTables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimProfileTable"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaProfileTablesUpdateProfileTable": {
+ "type": "object",
+ "properties": {
+ "subsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "layoutGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A table within a profile. Contains display customization."
+ },
+ "GrantaServerApiSchemaProfilesAllProfilesInfo": {
+ "type": "object",
+ "properties": {
+ "profiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimProfile"
+ },
+ "nullable": true
+ },
+ "defaultProfile": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimProfile"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiSchemaProfilesCreateProfile": {
+ "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
+ },
+ "GrantaServerApiSchemaProfilesProfile": {
+ "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/GrantaServerApiSchemaSlimEntitiesSlimProfileTable"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiSchemaProfilesUpdateAllProfilesInfo": {
+ "type": "object",
+ "properties": {
+ "profiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "defaultProfile": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateDefaultProfile"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Used to update the list of all profiles as well as default profile."
+ },
+ "GrantaServerApiSchemaProfilesUpdateDefaultProfile": {
+ "required": [
+ "key"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key is a unique identifier of a profile. Separate from guid."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaProfilesUpdateProfile": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "homepageUrl": {
+ "type": "string",
+ "nullable": true
+ },
+ "profileTableGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "description": "Guid is a unique identifier of a profile. Separate from key.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "groupName": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A profile, consisting of a set of tables from one or more databases."
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsAttributeLinkPair": {
+ "type": "object",
+ "properties": {
+ "attributeSource": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ },
+ "attributeTarget": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateAttributeLinkPair": {
+ "required": [
+ "attributeSourceGuid",
+ "attributeTargetGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "attributeSourceGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "attributeTargetGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateCrossDatabaseRecordLinkGroup": {
+ "required": [
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "crossDatabase"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup",
+ "x-discriminator-value": "crossDatabase"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateDynamicRecordLinkGroup": {
+ "required": [
+ "attributePairs",
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dynamic"
+ },
+ "forbidOrphans": {
+ "type": "boolean"
+ },
+ "referentialIntegrityModel": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel"
+ },
+ "attributePairs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateAttributeLinkPair"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup",
+ "x-discriminator-value": "dynamic"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup": {
+ "required": [
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "linkTarget": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkTarget"
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaRecordLinkGroupsCreateStaticRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsCreateDynamicRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsCreateCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateStaticRecordLinkGroup": {
+ "required": [
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "static"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup",
+ "x-discriminator-value": "static"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCrossDatabaseRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "includeIndirectLinks",
+ "linkInfo",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "crossDatabase"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup",
+ "x-discriminator-value": "crossDatabase"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsDynamicRecordLinkGroup": {
+ "required": [
+ "attributePairs",
+ "displayNames",
+ "forbidOrphans",
+ "guid",
+ "linkInfo",
+ "name",
+ "referentialIntegrityModel",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dynamic"
+ },
+ "forbidOrphans": {
+ "type": "boolean"
+ },
+ "referentialIntegrityModel": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel"
+ },
+ "attributePairs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsAttributeLinkPair"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup",
+ "x-discriminator-value": "dynamic"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsLinkInfo": {
+ "required": [
+ "linkSource",
+ "linkTarget"
+ ],
+ "type": "object",
+ "properties": {
+ "linkSource": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkTarget"
+ },
+ "linkTarget": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkTarget"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsLinkTarget": {
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "databaseVersionGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "linkInfo",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "linkInfo": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkInfo"
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "reverseDisplayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaRecordLinkGroupsStaticRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsDynamicRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupType": {
+ "enum": [
+ "static",
+ "dynamic",
+ "crossDatabase"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupsInfo": {
+ "type": "object",
+ "properties": {
+ "recordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimRecordLinkGroup"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel": {
+ "enum": [
+ "oneToOne",
+ "oneToMany",
+ "manyToMany"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsStaticRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "includeIndirectLinks",
+ "linkInfo",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "static"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup",
+ "x-discriminator-value": "static"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateCrossDatabaseRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "crossDatabase"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup",
+ "x-discriminator-value": "crossDatabase"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateDynamicRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "forbidOrphans": {
+ "type": "boolean"
+ },
+ "referentialIntegrityModel": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel"
+ },
+ "attributePairs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateAttributeLinkPair"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "dynamic"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup",
+ "x-discriminator-value": "dynamic"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "reverseName": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaRecordLinkGroupsUpdateStaticRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsUpdateDynamicRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsUpdateCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateStaticRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "static"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup",
+ "x-discriminator-value": "static"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimAttribute": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimConfiguration": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimConstant": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "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"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimDatabase": {
+ "required": [
+ "guid",
+ "isLocked",
+ "isReadOnly",
+ "key",
+ "name",
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "versionGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabaseStatus"
+ },
+ "isReadOnly": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "indexInSync": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "indexUpToDate": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "indexOutOfDateDuration": {
+ "type": "string",
+ "format": "date-span",
+ "nullable": true
+ },
+ "schemaVersion": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimEntity": {
+ "required": [
+ "guid"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimExpression": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimFile": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimLayout": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimLayoutSection": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sectionDetailType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sectionDetailType": {
+ "type": "string",
+ "default": "slim"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutSection",
+ "x-discriminator-value": "slim"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimNamedEntity": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimObjects": {
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimProfile": {
+ "required": [
+ "isImplicit",
+ "key",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "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": "Profile stripped down to only the basic fields"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimProfileTable": {
+ "required": [
+ "databaseGuid",
+ "tableGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "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": "Profile table stripped to just the basic fields"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupType"
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "reverseDisplayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimSubset": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimTable": {
+ "required": [
+ "displayNames",
+ "guid",
+ "isHiddenFromBrowse",
+ "isHiddenFromSearch",
+ "isVersioned",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "isVersioned": {
+ "type": "boolean"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimUnit": {
+ "required": [
+ "guid",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimUnitSystem": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Unit system stripped down to its basic fields (mappings excluded)."
+ },
+ "GrantaServerApiSchemaStandardNamesCreateStandardName": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedCrossDatabaseRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaStandardNamesStandardName": {
+ "required": [
+ "guid",
+ "mappedAttributes",
+ "mappedCrossDatabaseRecordLinkGroups",
+ "mappedParameters",
+ "mappedRecordLinkGroups",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "mappedRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "mappedCrossDatabaseRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaStandardNamesStandardNamesInfo": {
+ "type": "object",
+ "properties": {
+ "standardNames": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardName"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaStandardNamesUpdateStandardName": {
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedCrossDatabaseRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsCreateSubset": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsSubset": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsSubsetsInfo": {
+ "type": "object",
+ "properties": {
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimSubset"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsUpdateSubset": {
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesCreateTable": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesTable": {
+ "required": [
+ "displayNames",
+ "guid",
+ "isHiddenFromBrowse",
+ "isHiddenFromSearch",
+ "isVersioned",
+ "layouts",
+ "name",
+ "subsets"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultSubset": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimSubset"
+ },
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimSubset"
+ }
+ },
+ "defaultLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ }
+ },
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "isVersioned": {
+ "type": "boolean"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesTablesInfo": {
+ "type": "object",
+ "properties": {
+ "tables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimTable"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesUpdateTable": {
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "defaultSubsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "defaultLayoutGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedAttributeTabularColumn": {
+ "required": [
+ "columnType",
+ "linkedAttribute",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedAttribute"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "linkedAttribute"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedColumnTabularColumn": {
+ "required": [
+ "columnType",
+ "linkedColumn",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedColumn"
+ },
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "linkedColumn"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedRecordTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedRecord"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "linkedRecord"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDateTimeTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDateTime"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localDateTime"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDiscreteTabularColumn": {
+ "required": [
+ "columnType",
+ "discreteType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDiscrete"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localDiscrete"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalFileTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localFile"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localFile"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalHyperlinkTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localHyperlink"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localHyperlink"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalIntegerTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localInteger"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localInteger"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLogicalTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLogical"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localLogical"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLongTextTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLongText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localLongText"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPictureTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPicture"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localPicture"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPointTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPoint"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localPoint"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalRangeTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localRange"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localRange"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalShortTextTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localShortText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localShortText"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "showAsLink": {
+ "type": "boolean"
+ },
+ "summaryRowEnabled": {
+ "type": "boolean"
+ },
+ "summaryRowText": {
+ "type": "string",
+ "nullable": true
+ },
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRowRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedAttributeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedColumnTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedRecordTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPointTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalRangeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalIntegerTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLogicalTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalShortTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLongTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDateTimeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDiscreteTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalHyperlinkTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalFileTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPictureTabularColumn",
+ "discriminator": {
+ "propertyName": "columnType",
+ "mapping": {
+ "linkedAttribute": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPictureTabularColumn"
+ }
+ }
+ },
+ "GrantaServerApiSchemaTabularColumnsLinkedAttributeTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "linkedAttribute",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedAttribute"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "linkedAttribute"
+ },
+ "GrantaServerApiSchemaTabularColumnsLinkedColumnTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "linkedAttribute",
+ "linkedColumn",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedColumn"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ },
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "linkedColumn"
+ },
+ "GrantaServerApiSchemaTabularColumnsLinkedRecordTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedRecord"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "linkedRecord"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalDateTimeTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDateTime"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localDateTime"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalDiscreteTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "discreteType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDiscrete"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localDiscrete"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalFileTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localFile"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localFile"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalHyperlinkTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localHyperlink"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localHyperlink"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalIntegerTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localInteger"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localInteger"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalLogicalTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLogical"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localLogical"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalLongTextTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLongText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localLongText"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalPictureTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPicture"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localPicture"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalPointTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPoint"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localPoint"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalRangeTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localRange"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localRange"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalShortTextTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localShortText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localShortText"
+ },
+ "GrantaServerApiSchemaTabularColumnsTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "properties": {
+ "showAsLink": {
+ "type": "boolean"
+ },
+ "summaryRowEnabled": {
+ "type": "boolean"
+ },
+ "summaryRowText": {
+ "type": "string"
+ },
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRowRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaTabularColumnsLinkedAttributeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLinkedColumnTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLinkedRecordTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalPointTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalRangeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalIntegerTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalLogicalTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalShortTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalLongTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalDateTimeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalDiscreteTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalHyperlinkTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalFileTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalPictureTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUnavailableTabularColumn",
+ "discriminator": {
+ "propertyName": "columnType",
+ "mapping": {
+ "linkedAttribute": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalPictureTabularColumn",
+ "unavailable": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUnavailableTabularColumn"
+ }
+ }
+ },
+ "GrantaServerApiSchemaTabularColumnsTabularColumnDtoType": {
+ "enum": [
+ "linkedAttribute",
+ "linkedRecord",
+ "linkedColumn",
+ "localInteger",
+ "localPoint",
+ "localRange",
+ "localLogical",
+ "localShortText",
+ "localLongText",
+ "localDateTime",
+ "localDiscrete",
+ "localHyperlink",
+ "localFile",
+ "localPicture",
+ "unavailable"
+ ],
+ "type": "string",
+ "description": "The types of tabular column."
+ },
+ "GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType": {
+ "enum": [
+ "list",
+ "max",
+ "min",
+ "mean",
+ "stdDev",
+ "sum",
+ "count",
+ "countDistinct",
+ "listDistinct",
+ "coefficientOfVariation",
+ "chart"
+ ],
+ "type": "string",
+ "description": "The roll up types of a tabular column."
+ },
+ "GrantaServerApiSchemaTabularColumnsUnavailableTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "unavailable"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "unavailable"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedAttributeTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedAttribute"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "linkedAttribute"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedColumnTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedColumn"
+ },
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "linkedColumn"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedRecordTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedRecord"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "linkedRecord"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDateTimeTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDateTime"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localDateTime"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDiscreteTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDiscrete"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localDiscrete"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalFileTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localFile"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localFile"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalHyperlinkTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localHyperlink"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localHyperlink"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalIntegerTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localInteger"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localInteger"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLogicalTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLogical"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localLogical"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLongTextTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLongText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localLongText"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPictureTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPicture"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localPicture"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPointTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPoint"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localPoint"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalRangeTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localRange"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localRange"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalShortTextTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localShortText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localShortText"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "properties": {
+ "showAsLink": {
+ "type": "boolean"
+ },
+ "summaryRowEnabled": {
+ "type": "boolean"
+ },
+ "summaryRowText": {
+ "type": "string",
+ "nullable": true
+ },
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRowRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedAttributeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedColumnTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedRecordTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPointTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalRangeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalIntegerTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLogicalTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalShortTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLongTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDateTimeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDiscreteTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalHyperlinkTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalFileTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPictureTabularColumn",
+ "discriminator": {
+ "propertyName": "columnType",
+ "mapping": {
+ "linkedAttribute": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPictureTabularColumn"
+ }
+ }
+ },
+ "GrantaServerApiSchemaUnitsCreateUnit": {
+ "required": [
+ "name",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsCreateUnitSystem": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Unit Systems\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "GrantaServerApiSchemaUnitsUnit": {
+ "required": [
+ "guid",
+ "name",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "symbol": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitEquivalent": {
+ "required": [
+ "equivalentUnit",
+ "unit",
+ "unitSystem"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ },
+ "unitSystem": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ },
+ "equivalentUnit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitEquivalentsInfo": {
+ "type": "object",
+ "properties": {
+ "unitEquivalents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitEquivalent"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitMapping": {
+ "required": [
+ "equivalentUnit",
+ "unit"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "equivalentUnit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitSystem": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "unitMappings"
+ ],
+ "type": "object",
+ "properties": {
+ "unitMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitMapping"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Unit system contains mappings from any unit to equivalent unit within this unit system.\r\nIf some unit comes from particular unit system it will be mapped to itself."
+ },
+ "GrantaServerApiSchemaUnitsUnitSystemsInfo": {
+ "type": "object",
+ "properties": {
+ "unitSystems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnitSystem"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitUsage": {
+ "required": [
+ "attributes",
+ "constants",
+ "expressions",
+ "parameters",
+ "units"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "constants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitsInfo": {
+ "type": "object",
+ "properties": {
+ "units": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUpdateUnit": {
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUpdateUnitSystem": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUpdateDatabase": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "string",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "currencyCode": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchAttributeCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "isMetaAttribute": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Base class for attribute criterions. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GrantaServerApiSearchCriterion\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchAttributeMatchesCriterion\r\n * GrantaServerApiSearchAttributeExistsCriterion\r\n * GrantaServerApiSearchAttributeNotApplicableCriterion",
+ "discriminator": {
+ "propertyName": "attributeCriterionType",
+ "mapping": {
+ "matches": "#/components/schemas/GrantaServerApiSearchAttributeMatchesCriterion",
+ "exists": "#/components/schemas/GrantaServerApiSearchAttributeExistsCriterion",
+ "notApplicable": "#/components/schemas/GrantaServerApiSearchAttributeNotApplicableCriterion"
+ }
+ },
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSearchAttributeExistsCriterion": {
+ "required": [
+ "attributeCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchAttributeCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ "attributeCriterionType": {
+ "type": "string",
+ "default": "exists"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchAttributeCriterion",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiSearchAttributeMatchesCriterion": {
+ "required": [
+ "attributeCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchAttributeCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ "attributeCriterionType": {
+ "type": "string",
+ "default": "matches"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchAttributeCriterion",
+ "x-discriminator-value": "matches"
+ },
+ "GrantaServerApiSearchAttributeNotApplicableCriterion": {
+ "required": [
+ "attributeCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchAttributeCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeCriterionType": {
+ "type": "string",
+ "default": "notApplicable"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchAttributeCriterion",
+ "x-discriminator-value": "notApplicable"
+ },
+ "GrantaServerApiSearchAttributeSortCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "attributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "sortType": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortType"
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiSearchSortCriterion",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSearchBooleanCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "description": "Only records that match all of these criteria are returned.",
+ "nullable": true
+ },
+ "any": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "description": "Only results that match any of these criteria are returned.",
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "description": "Only results that match none of these criteria are returned.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "boolean"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "boolean"
+ },
+ "GrantaServerApiSearchBoostByGuid": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "boostFactor": {
+ "type": "number",
+ "format": "double",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchBoostByIdentity": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "boostFactor": {
+ "type": "number",
+ "format": "double",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiSearchBooleanCriterion\r\n * GrantaServerApiSearchFreeTextCriterion\r\n * GrantaServerApiSearchRecordListMemberCriterion\r\n * GrantaServerApiSearchRecordPropertyCriterion\r\n * GrantaServerApiSearchRecordReferenceCriterion\r\n * GrantaServerApiSearchRecordAncestorCriterion\r\n * GrantaServerApiSearchRecordAncestorHistoryIdentitiesCriterion\r\n * GrantaServerApiSearchRecordSubsetCriterion\r\n * GrantaServerApiSearchTabularLinkingValueCriterion\r\n * GrantaServerApiSearchAttributeCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "boolean": "#/components/schemas/GrantaServerApiSearchBooleanCriterion",
+ "text": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion",
+ "recordListMember": "#/components/schemas/GrantaServerApiSearchRecordListMemberCriterion",
+ "recordProperty": "#/components/schemas/GrantaServerApiSearchRecordPropertyCriterion",
+ "reference": "#/components/schemas/GrantaServerApiSearchRecordReferenceCriterion",
+ "recordAncestor": "#/components/schemas/GrantaServerApiSearchRecordAncestorCriterion",
+ "recordAncestorIdentities": "#/components/schemas/GrantaServerApiSearchRecordAncestorHistoryIdentitiesCriterion",
+ "subset": "#/components/schemas/GrantaServerApiSearchRecordSubsetCriterion",
+ "tabularLinkingValue": "#/components/schemas/GrantaServerApiSearchTabularLinkingValueCriterion",
+ "attribute": "#/components/schemas/GrantaServerApiSearchAttributeCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchDateTimeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSearchDatumCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiSearchDateTimeDatumCriterion\r\n * GrantaServerApiSearchDiscreteFunctionalRangeDatumCriterion\r\n * GrantaServerApiSearchDiscreteFunctionalValuesDatumCriterion\r\n * GrantaServerApiSearchDiscreteIdentityDatumCriterion\r\n * GrantaServerApiSearchDiscreteIdentityValuesDatumCriterion\r\n * GrantaServerApiSearchDiscreteGuidDatumCriterion\r\n * GrantaServerApiSearchDiscreteGuidValuesDatumCriterion\r\n * GrantaServerApiSearchDiscreteRangeDatumCriterion\r\n * GrantaServerApiSearchDiscreteTextDatumCriterion\r\n * GrantaServerApiSearchDiscreteTextValuesDatumCriterion\r\n * GrantaServerApiSearchFileDatumCriterion\r\n * GrantaServerApiSearchFloatFunctionalDatumCriterion\r\n * GrantaServerApiSearchFloatFunctionalGraphDatumCriterion\r\n * GrantaServerApiSearchHyperlinkDatumCriterion\r\n * GrantaServerApiSearchIntegerDatumCriterion\r\n * GrantaServerApiSearchLinkDatumCriterion\r\n * GrantaServerApiSearchLogicalDatumCriterion\r\n * GrantaServerApiSearchLongTextDatumCriterion\r\n * GrantaServerApiSearchMathsFunctionalDatumCriterion\r\n * GrantaServerApiSearchPictureDatumCriterion\r\n * GrantaServerApiSearchPointDatumCriterion\r\n * GrantaServerApiSearchRangeDatumCriterion\r\n * GrantaServerApiSearchShortTextDatumCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "dateTime": "#/components/schemas/GrantaServerApiSearchDateTimeDatumCriterion",
+ "discreteFunctionalRange": "#/components/schemas/GrantaServerApiSearchDiscreteFunctionalRangeDatumCriterion",
+ "discreteFunctionalValues": "#/components/schemas/GrantaServerApiSearchDiscreteFunctionalValuesDatumCriterion",
+ "discreteIdentity": "#/components/schemas/GrantaServerApiSearchDiscreteIdentityDatumCriterion",
+ "discreteIdentityValues": "#/components/schemas/GrantaServerApiSearchDiscreteIdentityValuesDatumCriterion",
+ "discreteGuid": "#/components/schemas/GrantaServerApiSearchDiscreteGuidDatumCriterion",
+ "discreteGuidValues": "#/components/schemas/GrantaServerApiSearchDiscreteGuidValuesDatumCriterion",
+ "discreteRange": "#/components/schemas/GrantaServerApiSearchDiscreteRangeDatumCriterion",
+ "discreteText": "#/components/schemas/GrantaServerApiSearchDiscreteTextDatumCriterion",
+ "discreteTextValues": "#/components/schemas/GrantaServerApiSearchDiscreteTextValuesDatumCriterion",
+ "file": "#/components/schemas/GrantaServerApiSearchFileDatumCriterion",
+ "floatFunctionalData": "#/components/schemas/GrantaServerApiSearchFloatFunctionalDatumCriterion",
+ "floatFunctionalGraph": "#/components/schemas/GrantaServerApiSearchFloatFunctionalGraphDatumCriterion",
+ "hyperlink": "#/components/schemas/GrantaServerApiSearchHyperlinkDatumCriterion",
+ "integer": "#/components/schemas/GrantaServerApiSearchIntegerDatumCriterion",
+ "link": "#/components/schemas/GrantaServerApiSearchLinkDatumCriterion",
+ "logical": "#/components/schemas/GrantaServerApiSearchLogicalDatumCriterion",
+ "longText": "#/components/schemas/GrantaServerApiSearchLongTextDatumCriterion",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSearchMathsFunctionalDatumCriterion",
+ "picture": "#/components/schemas/GrantaServerApiSearchPictureDatumCriterion",
+ "point": "#/components/schemas/GrantaServerApiSearchPointDatumCriterion",
+ "range": "#/components/schemas/GrantaServerApiSearchRangeDatumCriterion",
+ "shortText": "#/components/schemas/GrantaServerApiSearchShortTextDatumCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchDatumExistsCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiSearchLinkExistsDatumCriterion\r\n * GrantaServerApiSearchSimpleDatumExistsCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "link": "#/components/schemas/GrantaServerApiSearchLinkExistsDatumCriterion",
+ "type": "#/components/schemas/GrantaServerApiSearchSimpleDatumExistsCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchDiscreteFunctionalRangeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctionalRange"
+ },
+ "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/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Optional unit string. If not included, the gte and lte values are assumed to be in database units.",
+ "nullable": true,
+ "readOnly": 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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteFunctionalRange"
+ },
+ "GrantaServerApiSearchDiscreteFunctionalValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteFunctionalValues"
+ },
+ "constraints": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.",
+ "nullable": true,
+ "readOnly": true
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteFunctionalValues"
+ },
+ "GrantaServerApiSearchDiscreteGuidDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteGuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "discreteGuid: Criterion for matching records where the GUID of the discrete data matches the specified value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteGuid"
+ },
+ "GrantaServerApiSearchDiscreteGuidValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteGuidValues"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteGuidValues"
+ },
+ "GrantaServerApiSearchDiscreteIdentityDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteIdentity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "discreteIdentity: Criterion for matching records where the identity of the discrete data matches the specified value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteIdentity"
+ },
+ "GrantaServerApiSearchDiscreteIdentityValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteIdentityValues"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteIdentityValues"
+ },
+ "GrantaServerApiSearchDiscreteParameterNameConstraint": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "any": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteName"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchParameterConstraint",
+ "x-discriminator-value": "discreteName"
+ },
+ "GrantaServerApiSearchDiscreteParameterValueConstraint": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "any": {
+ "type": "array",
+ "items": {
+ "type": "number",
+ "format": "double"
+ },
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "type": "number",
+ "format": "double"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchParameterConstraint",
+ "x-discriminator-value": "discreteValue"
+ },
+ "GrantaServerApiSearchDiscreteRangeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "discreteRange"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteRange"
+ },
+ "GrantaServerApiSearchDiscreteTextDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "textMatchBehaviour": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchTextMatchBehaviour"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "discreteText: Criterion for matching records where the text of the discrete data contains the specified value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteText"
+ },
+ "GrantaServerApiSearchDiscreteTextValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "any": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "textMatchBehaviour": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchTextMatchBehaviour"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteTextValues"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteTextValues"
+ },
+ "GrantaServerApiSearchDoubleSortingValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "type": {
+ "type": "string",
+ "default": "double"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchSortingValue",
+ "x-discriminator-value": "double"
+ },
+ "GrantaServerApiSearchFileDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSearchFloatFunctionalDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctionalData"
+ },
+ "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/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.",
+ "nullable": true,
+ "readOnly": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "floatFunctionalData: Criterion for matching records with float functional data\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "floatFunctionalData"
+ },
+ "GrantaServerApiSearchFloatFunctionalGraphDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctionalGraph"
+ },
+ "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": "floatFunctionalGraph: Criterion for matching records with float functional data\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "floatFunctionalGraph"
+ },
+ "GrantaServerApiSearchFreeTextAllAttributesCriterion": {
+ "required": [
+ "freeTextCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "guidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "freeTextCriterionType": {
+ "type": "string",
+ "default": "allAttributes"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Runs a query for the specified term against all attributes.\r\nIf any identifiers are provided, all fields must use either identities or GUIDs.\r\n\r\nThis extends: GrantaServerApiSearchFreeTextCriterion",
+ "x-discriminator-value": "allAttributes"
+ },
+ "GrantaServerApiSearchFreeTextAllCriterion": {
+ "required": [
+ "freeTextCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "attributeGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "columnIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "columnGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "freeTextCriterionType": {
+ "type": "string",
+ "default": "all"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Runs a query for the specified term against all attributes and tabular local columns.\r\nIf any identifiers are provided, all fields must use either identities or GUIDs.\r\n\r\nThis extends: GrantaServerApiSearchFreeTextCriterion",
+ "x-discriminator-value": "all"
+ },
+ "GrantaServerApiSearchFreeTextAllLocalColumnsCriterion": {
+ "required": [
+ "freeTextCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "columnGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "freeTextCriterionType": {
+ "type": "string",
+ "default": "allLocalColumns"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Runs a query for the specified term against all tabular local columns.\r\nIf any identifiers are provided, all fields must use either identities or GUIDs.\r\n\r\nThis extends: GrantaServerApiSearchFreeTextCriterion",
+ "x-discriminator-value": "allLocalColumns"
+ },
+ "GrantaServerApiSearchFreeTextCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ }
+ ],
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Base type for free text criteria.\r\n\r\nThis extends: GrantaServerApiSearchCriterion\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchFreeTextAllCriterion\r\n * GrantaServerApiSearchFreeTextAllAttributesCriterion\r\n * GrantaServerApiSearchFreeTextExcludingAttributesCriterion\r\n * GrantaServerApiSearchFreeTextSpecifiedAttributesCriterion\r\n * GrantaServerApiSearchFreeTextAllLocalColumnsCriterion\r\n * GrantaServerApiSearchFreeTextExcludingLocalColumnsCriterion\r\n * GrantaServerApiSearchFreeTextSpecifiedLocalColumnsCriterion",
+ "discriminator": {
+ "propertyName": "freeTextCriterionType",
+ "mapping": {
+ "all": "#/components/schemas/GrantaServerApiSearchFreeTextAllCriterion",
+ "allAttributes": "#/components/schemas/GrantaServerApiSearchFreeTextAllAttributesCriterion",
+ "excludingAttributes": "#/components/schemas/GrantaServerApiSearchFreeTextExcludingAttributesCriterion",
+ "specifiedAttributes": "#/components/schemas/GrantaServerApiSearchFreeTextSpecifiedAttributesCriterion",
+ "allLocalColumns": "#/components/schemas/GrantaServerApiSearchFreeTextAllLocalColumnsCriterion",
+ "excludingLocalColumns": "#/components/schemas/GrantaServerApiSearchFreeTextExcludingLocalColumnsCriterion",
+ "specifiedLocalColumns": "#/components/schemas/GrantaServerApiSearchFreeTextSpecifiedLocalColumnsCriterion"
+ }
+ },
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiSearchFreeTextExcludingAttributesCriterion": {
+ "required": [
+ "freeTextCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "identitiesToExclude": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "guidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "guidsToExclude": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "freeTextCriterionType": {
+ "type": "string",
+ "default": "excludingAttributes"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Runs a query for the specified term against all attributes, excluding the specified attributes.\r\nAll fields must use either identities or GUIDs.\r\n\r\nThis extends: GrantaServerApiSearchFreeTextCriterion",
+ "x-discriminator-value": "excludingAttributes"
+ },
+ "GrantaServerApiSearchFreeTextExcludingLocalColumnsCriterion": {
+ "required": [
+ "freeTextCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "columnIdentitiesToExclude": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "columnGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "columnGuidsToExclude": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "freeTextCriterionType": {
+ "type": "string",
+ "default": "excludingLocalColumns"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Runs a query for the specified term against all tabular local columns, excluding specified tabular local columns.\r\nAll fields must use either identities or GUIDs.\r\n\r\nThis extends: GrantaServerApiSearchFreeTextCriterion",
+ "x-discriminator-value": "excludingLocalColumns"
+ },
+ "GrantaServerApiSearchFreeTextSpecifiedAttributesCriterion": {
+ "required": [
+ "freeTextCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "identitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "guids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "guidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "freeTextCriterionType": {
+ "type": "string",
+ "default": "specifiedAttributes"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Runs a query for the specified term against specified attributes.\r\nAll fields must use either identities or GUIDs.\r\n\r\nThis extends: GrantaServerApiSearchFreeTextCriterion",
+ "x-discriminator-value": "specifiedAttributes"
+ },
+ "GrantaServerApiSearchFreeTextSpecifiedLocalColumnsCriterion": {
+ "required": [
+ "freeTextCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "columnIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "columnGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "columnGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "freeTextCriterionType": {
+ "type": "string",
+ "default": "specifiedLocalColumns"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Runs a query for the specified term against specified tabular local columns.\r\nAll fields must use either identities or GUIDs.\r\n\r\nThis extends: GrantaServerApiSearchFreeTextCriterion",
+ "x-discriminator-value": "specifiedLocalColumns"
+ },
+ "GrantaServerApiSearchHyperlinkDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "hyperlink: Criterion for matching records where the hyperlink description contains the given value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSearchIndexStatus": {
+ "type": "object",
+ "properties": {
+ "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,
+ "readOnly": 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
+ },
+ "diskStatus": {
+ "$ref": "#/components/schemas/GrantaServerApiDiskStatus"
+ },
+ "diskThreshold": {
+ "type": "string",
+ "description": "The 'flood stage' threshold from Elasticsearch.",
+ "nullable": true
+ },
+ "searchIndexUnavailable": {
+ "type": "boolean",
+ "description": "True if the index could not be contacted.",
+ "nullable": true
+ },
+ "recordsThatFailedToIndex": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIndexRecordFailure"
+ },
+ "description": "Details of any records that failed to index.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchIntegerDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "integer"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSearchLinkDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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/GrantaServerApiSearchCriterion"
+ },
+ "linkDatumType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "indirectLinks": {
+ "$ref": "#/components/schemas/GrantaServerApiIndirectLinks"
+ },
+ "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/GrantaServerApiSearchCriterion"
+ },
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "localRowsBehaviour": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLocalRowsBehaviour"
+ }
+ }
+ }
+ ],
+ "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\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSearchLinkExistsDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "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",
+ "nullable": true
+ },
+ "linkDatumType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "indirectLinks": {
+ "$ref": "#/components/schemas/GrantaServerApiIndirectLinks"
+ },
+ "searchInReversedDirection": {
+ "type": "boolean"
+ },
+ "localRowsBehaviour": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLocalRowsBehaviour"
+ },
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "link"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSearchLinkingValueMatchBehaviour": {
+ "enum": [
+ "AllRows",
+ "VisibleRows",
+ "ExactMatchMatchingRows",
+ "FreeTextMatchingRows"
+ ],
+ "type": "string",
+ "description": "Enum for use in the Granta.Server.Api.Search.TabularLinkingValueCriterion to control which tabular rows are returnedPossible 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"
+ },
+ "GrantaServerApiSearchLocalRowsBehaviour": {
+ "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"
+ },
+ "GrantaServerApiSearchLogicalDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean",
+ "description": "Logical search value"
+ },
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSearchLongSortingValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "type": {
+ "type": "string",
+ "default": "long"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchSortingValue",
+ "x-discriminator-value": "long"
+ },
+ "GrantaServerApiSearchLongTextDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Long text search value",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSearchMathsFunctionalDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "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/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.",
+ "nullable": true,
+ "readOnly": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "mathsFunctional: Criterion for matching records with maths functional data (EELs)\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSearchNumericParameterConstraint": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "gte": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "lte": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "scaleType": {
+ "type": "string",
+ "description": "Optionally, override the scale type of the parameter. Can be Linear or Log",
+ "nullable": true
+ },
+ "interpolationType": {
+ "type": "string",
+ "description": "Optionally, override the interpolation type of the parameter. Can be Auto, None, Linear or CubicSpline",
+ "nullable": true
+ },
+ "significantFigures": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchParameterConstraint",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSearchPagingOptions": {
+ "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,
+ "readOnly": 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"
+ },
+ "GrantaServerApiSearchParameterConstraint": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchDiscreteParameterNameConstraint\r\n * GrantaServerApiSearchDiscreteParameterValueConstraint\r\n * GrantaServerApiSearchNumericParameterConstraint",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discreteName": "#/components/schemas/GrantaServerApiSearchDiscreteParameterNameConstraint",
+ "discreteValue": "#/components/schemas/GrantaServerApiSearchDiscreteParameterValueConstraint",
+ "numeric": "#/components/schemas/GrantaServerApiSearchNumericParameterConstraint"
+ }
+ }
+ },
+ "GrantaServerApiSearchPictureDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "picture: Criterion for matching records where picture data exists.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSearchPointDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "gte": {
+ "type": "number",
+ "description": "Greater than or equal",
+ "format": "double",
+ "nullable": true
+ },
+ "lte": {
+ "type": "number",
+ "description": "Less than or equal",
+ "format": "double",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "point"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSearchRangeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "range"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSearchRecordAncestorCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ancestorIdentity": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "directParentOnly": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordAncestor"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor identity is provided, returns records that sit directly below the table\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordAncestor"
+ },
+ "GrantaServerApiSearchRecordAncestorHistoryIdentitiesCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ancestorHistoryIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordAncestorIdentities"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records whose ancestors include one of the specified record history identities\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordAncestorIdentities"
+ },
+ "GrantaServerApiSearchRecordListMemberCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordListIdentifiers": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordListMember"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records contained within at least one of the referenced record lists.\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordListMember"
+ },
+ "GrantaServerApiSearchRecordPropertyCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchableRecordProperty"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ "type": {
+ "type": "string",
+ "default": "recordProperty"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion for a search matching values in a given record property.\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordProperty"
+ },
+ "GrantaServerApiSearchRecordPropertySortCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchableRecordProperty"
+ },
+ "sortType": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortType"
+ },
+ "type": {
+ "type": "string",
+ "default": "recordProperty"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Specifies a record property based sort criterion for a search query.\r\n\r\nThis extends: GrantaServerApiSearchSortCriterion",
+ "x-discriminator-value": "recordProperty"
+ },
+ "GrantaServerApiSearchRecordReferenceCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "reference"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records matching a specific reference. The database key must be provided, along with either the record GUID or the record identity.\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "reference"
+ },
+ "GrantaServerApiSearchRecordSubsetCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "subsetIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "subsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "subset"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "subset"
+ },
+ "GrantaServerApiSearchRelevanceSortCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "relevance"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Specifies a relevance based sort criterion for a search query\r\n\r\nThis extends: GrantaServerApiSearchSortCriterion",
+ "x-discriminator-value": "relevance"
+ },
+ "GrantaServerApiSearchSearchRequest": {
+ "type": "object",
+ "properties": {
+ "criterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "sortCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ "description": "An optional set of attribute based sort criteria. If none are provided, the results will be sorted in descending relevance order.",
+ "nullable": true
+ },
+ "pagingOptions": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchPagingOptions"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchResponse": {
+ "type": "object",
+ "properties": {
+ "searchIdentifier": {
+ "type": "string",
+ "description": "If the search request had paging options specified, this will return an identifier that can be used to get the rest of the results",
+ "format": "uuid",
+ "nullable": true
+ },
+ "totalResultCount": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResult"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchResult": {
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordName": {
+ "type": "string",
+ "nullable": true
+ },
+ "treeName": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordColor": {
+ "type": "string",
+ "nullable": true
+ },
+ "tableIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "cubicSplineStatus": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionControlState": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "parentIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordType"
+ },
+ "score": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "sortingValue": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchResultsRequest": {
+ "type": "object",
+ "properties": {
+ "pageNumber": {
+ "type": "integer",
+ "description": "The (1-indexed) number of the page to return from a search\r\nThe size of the page was determined by the original query",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchableRecordProperty": {
+ "enum": [
+ "createdDate",
+ "creator",
+ "lastModifiedDate",
+ "lastModifier",
+ "recordType",
+ "colour",
+ "versionState",
+ "versionNumber",
+ "recordName",
+ "treeName",
+ "databaseKey",
+ "tableName",
+ "tableIdentity"
+ ],
+ "type": "string",
+ "description": "Properties of a record that can be used to in searchesPossible 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- Colour: The colour of the record. See
\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
\r\n"
+ },
+ "GrantaServerApiSearchShortTextDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "textMatchBehaviour": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchTextMatchBehaviour"
+ },
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSearchSimpleDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "type"
+ }
+ }
+ }
+ ],
+ "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\n\r\nThis extends: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "type"
+ },
+ "GrantaServerApiSearchSortCriterion": {
+ "type": "object",
+ "properties": {
+ "sortDirection": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortDirection"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchAttributeSortCriterion\r\n * GrantaServerApiSearchRecordPropertySortCriterion\r\n * GrantaServerApiSearchRelevanceSortCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiSearchAttributeSortCriterion",
+ "recordProperty": "#/components/schemas/GrantaServerApiSearchRecordPropertySortCriterion",
+ "relevance": "#/components/schemas/GrantaServerApiSearchRelevanceSortCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchSortDirection": {
+ "enum": [
+ "ascending",
+ "descending"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSearchSortType": {
+ "enum": [
+ "natural",
+ "alphabetical"
+ ],
+ "type": "string",
+ "description": "For a text-type sort, whether the results should use a pure alphabetical or a natural sort (where multi-digit numbers within strings are treated as a single character for the purposes of sorting)."
+ },
+ "GrantaServerApiSearchSortingValue": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchDoubleSortingValue\r\n * GrantaServerApiSearchLongSortingValue\r\n * GrantaServerApiSearchStringSortingValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "double": "#/components/schemas/GrantaServerApiSearchDoubleSortingValue",
+ "long": "#/components/schemas/GrantaServerApiSearchLongSortingValue",
+ "text": "#/components/schemas/GrantaServerApiSearchStringSortingValue"
+ }
+ }
+ },
+ "GrantaServerApiSearchStringSortingValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchSortingValue",
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiSearchTabularLinkingValueCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "linkingValueMatchBehaviour": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLinkingValueMatchBehaviour"
+ },
+ "type": {
+ "type": "string",
+ "default": "tabularLinkingValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "tabularLinkingValue"
+ },
+ "GrantaServerApiSearchTextMatchBehaviour": {
+ "enum": [
+ "contains",
+ "exactMatch",
+ "exactMatchCaseInsensitive"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSelectionSearchesCreateSearchRequest": {
+ "type": "object",
+ "properties": {
+ "searchConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "detail": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSearchDetail"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesFindSearchRequest": {
+ "type": "object",
+ "properties": {
+ "nameContains": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesSaveSearchRequest": {
+ "type": "object",
+ "properties": {
+ "searchConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "detail": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSearchDetail"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesSearchDetail": {
+ "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
+ },
+ "GrantaServerApiSelectionSearchesSelectionSearch": {
+ "type": "object",
+ "properties": {
+ "searchIdentifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "currentUserAccessInfo": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ },
+ "nullable": true
+ },
+ "criteria": {
+ "type": "string",
+ "nullable": true
+ },
+ "exploreConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdUserOrGroup": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesUserOrGroup"
+ },
+ "lastModifiedTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedUserOrGroup": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesUserOrGroup"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesUserOrGroup": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayName": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSpecificValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "guids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "filterOn": {
+ "type": "string",
+ "default": "specific"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "specific"
+ },
+ "GrantaServerApiValueSpecifier": {
+ "type": "object",
+ "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 * GrantaServerApiAllValuesSpecifier\r\n * GrantaServerApiExcludeValuesSpecifier\r\n * GrantaServerApiSpecificValuesSpecifier\r\n * GrantaServerApiNoValuesSpecifier",
+ "discriminator": {
+ "propertyName": "filterOn",
+ "mapping": {
+ "all": "#/components/schemas/GrantaServerApiAllValuesSpecifier",
+ "exclude": "#/components/schemas/GrantaServerApiExcludeValuesSpecifier",
+ "specific": "#/components/schemas/GrantaServerApiSpecificValuesSpecifier",
+ "none": "#/components/schemas/GrantaServerApiNoValuesSpecifier"
+ }
+ }
+ },
+ "GrantaServerApiValueSpecifierType": {
+ "enum": [
+ "all",
+ "exclude",
+ "specific",
+ "none"
+ ],
+ "type": "string",
+ "description": "Types of ValueSpecifier allowed in requests.\r\nUsed by ValueSpecifier to specify whether we want all identities, some guids, exclude some identities, etc."
+ },
+ "GrantaServerApiVersionState": {
+ "enum": [
+ "unversioned",
+ "unreleased",
+ "released",
+ "superseded",
+ "withdrawn"
+ ],
+ "type": "string",
+ "description": "API-level enum for version control state."
+ },
+ "JsonPatchDocument": {
+ "type": "object",
+ "properties": {
+ "op": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "SystemIOStream": {
+ "type": "object",
+ "properties": {
+ "canRead": {
+ "type": "boolean",
+ "readOnly": true
+ },
+ "canSeek": {
+ "type": "boolean",
+ "readOnly": true
+ },
+ "canTimeout": {
+ "type": "boolean",
+ "readOnly": true
+ },
+ "canWrite": {
+ "type": "boolean",
+ "readOnly": true
+ },
+ "length": {
+ "type": "integer",
+ "format": "int64",
+ "readOnly": true
+ },
+ "position": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "readTimeout": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "writeTimeout": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "SystemNetHttpStatusCode": {
+ "enum": [
+ 100,
+ 101,
+ 200,
+ 201,
+ 202,
+ 203,
+ 204,
+ 205,
+ 206,
+ 300,
+ 301,
+ 302,
+ 303,
+ 304,
+ 305,
+ 306,
+ 307,
+ 400,
+ 401,
+ 402,
+ 403,
+ 404,
+ 405,
+ 406,
+ 407,
+ 408,
+ 409,
+ 410,
+ 411,
+ 412,
+ 413,
+ 414,
+ 415,
+ 416,
+ 417,
+ 426,
+ 500,
+ 501,
+ 502,
+ 503,
+ 504,
+ 505
+ ],
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/yaml/server-api-24r2.json b/yaml/server-api-24r2.json
new file mode 100644
index 00000000..b86b313d
--- /dev/null
+++ b/yaml/server-api-24r2.json
@@ -0,0 +1,42692 @@
+{
+ "openapi": "3.0.1",
+ "info": {
+ "title": "MI Server API",
+ "version": "v1"
+ },
+ "paths": {
+ "/v1alpha/databases/{database-key}/tables/{table-identity}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the table.",
+ "operationId": "DatabaseAggregationForTableWithIdentity",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "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/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"4256ed58-3d5b-48ff-b7e4-f8fa842fefc2","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"753f0a04-ab4f-481d-b141-25931b7d6646","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"04d7fc3e-0719-4fbc-98e1-58bb65b5ea1a","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"4256ed58-3d5b-48ff-b7e4-f8fa842fefc2","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"753f0a04-ab4f-481d-b141-25931b7d6646","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"04d7fc3e-0719-4fbc-98e1-58bb65b5ea1a","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"4256ed58-3d5b-48ff-b7e4-f8fa842fefc2","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"753f0a04-ab4f-481d-b141-25931b7d6646","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"04d7fc3e-0719-4fbc-98e1-58bb65b5ea1a","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 34": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 35": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 36": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 37": {
+ "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":"4256ed58-3d5b-48ff-b7e4-f8fa842fefc2","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"753f0a04-ab4f-481d-b141-25931b7d6646","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"04d7fc3e-0719-4fbc-98e1-58bb65b5ea1a","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 40": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the table.",
+ "operationId": "DatabaseAggregationForTableWithGuid",
+ "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/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"02598b69-3591-4742-b3b9-c7197e9df6e1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"d3d324c9-e8e9-4776-bfea-a6466cfedf21","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"8fe9a496-9b15-4bc7-9740-2cbc458e1159","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"02598b69-3591-4742-b3b9-c7197e9df6e1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"d3d324c9-e8e9-4776-bfea-a6466cfedf21","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"8fe9a496-9b15-4bc7-9740-2cbc458e1159","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"02598b69-3591-4742-b3b9-c7197e9df6e1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"d3d324c9-e8e9-4776-bfea-a6466cfedf21","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"8fe9a496-9b15-4bc7-9740-2cbc458e1159","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 42": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 43": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 44": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 45": {
+ "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":"02598b69-3591-4742-b3b9-c7197e9df6e1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"d3d324c9-e8e9-4776-bfea-a6466cfedf21","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"8fe9a496-9b15-4bc7-9740-2cbc458e1159","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 48": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the database.",
+ "operationId": "DatabaseAggregation",
+ "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/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"3636d315-1e2c-4330-b81f-2a59dae1c14f","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"f16b2846-72f0-4a0d-8ea8-7cc6e1a26f95","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"fa995889-fd8e-407e-99f7-131c325a8076","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"3636d315-1e2c-4330-b81f-2a59dae1c14f","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"f16b2846-72f0-4a0d-8ea8-7cc6e1a26f95","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"fa995889-fd8e-407e-99f7-131c325a8076","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"3636d315-1e2c-4330-b81f-2a59dae1c14f","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"f16b2846-72f0-4a0d-8ea8-7cc6e1a26f95","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"fa995889-fd8e-407e-99f7-131c325a8076","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 50": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 51": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 52": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 53": {
+ "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":"3636d315-1e2c-4330-b81f-2a59dae1c14f","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"f16b2846-72f0-4a0d-8ea8-7cc6e1a26f95","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"fa995889-fd8e-407e-99f7-131c325a8076","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 56": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the integration schema.",
+ "operationId": "IntegrationAggregation",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"dccf3116-5842-40ee-b632-f4020e760af1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"6a6e8610-a1e4-4d06-934b-37162b6d2617","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"7744c2a4-0c3a-4b7c-a1d9-d6fed16adc43","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"dccf3116-5842-40ee-b632-f4020e760af1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"6a6e8610-a1e4-4d06-934b-37162b6d2617","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"7744c2a4-0c3a-4b7c-a1d9-d6fed16adc43","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"dccf3116-5842-40ee-b632-f4020e760af1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"6a6e8610-a1e4-4d06-934b-37162b6d2617","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"7744c2a4-0c3a-4b7c-a1d9-d6fed16adc43","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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":[{"attributeAggregationCriterionType":"exists","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 58": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"type":"integer"},"identity":8965,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 59": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 60": {
+ "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":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"st","type":"shortText"},"identity":10907,"isMetaAttribute":false,"type":"attribute"}]}
+ },
+ "Example 61": {
+ "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":"dccf3116-5842-40ee-b632-f4020e760af1","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"6a6e8610-a1e4-4d06-934b-37162b6d2617","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"7744c2a4-0c3a-4b7c-a1d9-d6fed16adc43","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 64": {
+ "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"},"attributeCriterionType":"exists","identity":5872,"isMetaAttribute":false,"type":"attribute"},"aggregationCriteria":[{"attributeAggregationCriterionType":"value","innerCriterion":{"numberOfTerms":10,"prefix":"","type":"discreteText"},"identity":5876,"isMetaAttribute":false,"type":"attribute"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema 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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataDatum"
+ },
+ "examples": {
+ "Example 9": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 10": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataDatum"
+ },
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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}": {
+ "get": {
+ "tags": [
+ "Data"
+ ],
+ "summary": "Get a datum for a given database, record history, record version and attribute.",
+ "operationId": "GetDatumForVersion",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataDatum"
+ },
+ "examples": {
+ "Example 13": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 14": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataDatum"
+ },
+ "examples": {
+ "Example 15": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 16": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table, record history, record version, attribute or datum not found"
+ },
+ "400": {
+ "description": "Attribute is not an exportable type"
+ }
+ }
+ }
+ },
+ "/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",
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table, record history, attribute or datum not found"
+ },
+ "400": {
+ "description": "Attribute is not an exportable type"
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, record history, record version, attribute or datum not found"
+ },
+ "400": {
+ "description": "Attribute is not an exportable type"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/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. Must be a file or picture attribute.",
+ "operationId": "ExportBinaryDataForLatest",
+ "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": "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"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, record history, attribute or datum not found"
+ },
+ "400": {
+ "description": "Attribute is not an exportable type"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:search-index-status": {
+ "get": {
+ "tags": [
+ "Database"
+ ],
+ "summary": "Get Search Index Status for a given database",
+ "operationId": "GetSearchIndexStatus",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "include-diagnostics",
+ "in": "query",
+ "description": "",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchIndexStatus"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchIndexStatus"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchIndexStatus"
+ }
+ }
+ }
+ },
+ "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": [
+ "Database"
+ ],
+ "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": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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": "database-key",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-name",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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": "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportRequest"
+ },
+ "examples": {
+ "Example 14": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 15": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 16": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 21": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 22": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 23": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 24": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:export": {
+ "post": {
+ "tags": [
+ "DataExport"
+ ],
+ "summary": "Export data from the integration schema.",
+ "operationId": "ExportDataFromIntegrationSchema",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportIntegrationDataExportRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDataExportResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/help-location/url/{help-key}": {
+ "get": {
+ "tags": [
+ "HelpLocation"
+ ],
+ "summary": "Returns the URL that the given helpKey maps to.",
+ "operationId": "GetHelpUrl",
+ "parameters": [
+ {
+ "name": "help-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",
+ "in": "path",
+ "description": "The help key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "302": {
+ "description": "Redirect to the help location."
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Lists the available integration schemas.",
+ "operationId": "Schemas",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created successfully",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Returns validation errors information"
+ },
+ "403": {
+ "description": "Forbidden. User is not a global administrator or an administrator for the schema"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:search-index-status": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "operationId": "GetStatusForIntegrationSchema",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "include-diagnostics",
+ "in": "query",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas:search-index-status": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Returns the status of all available integration schemas.",
+ "operationId": "AllSchemaStatus",
+ "parameters": [
+ {
+ "name": "include-diagnostics",
+ "in": "query",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationIntegrationSchemaStatus"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}": {
+ "put": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Updates an integration schema, or adds a new one if there is not one with the same key already.\r\nWill fail if the schema is not valid, or if the user is not both a global administrator and an administrator for the schema.",
+ "operationId": "UpdateSchema",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Updated successfully",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Returns validation errors information"
+ },
+ "403": {
+ "description": "Forbidden. User is not a global administrator or an administrator for the schema"
+ }
+ }
+ },
+ "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",
+ "in": "path",
+ "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": "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}/sources/database/{database-key}/table/{table-identity}": {
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsGetJobsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsGetJobsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsGetJobsResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Create a new job.",
+ "operationId": "CreateJob",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created successfully",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": "Success",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsUpdateJobRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ },
+ "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": "Success"
+ },
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCreateJobRequest"
+ }
+ }
+ }
+ },
+ "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": "Success"
+ },
+ "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/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsResubmitJobRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ }
+ }
+ }
+ },
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCurrentUser"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCurrentUser"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsCurrentUser"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/job-queue/processing-configuration": {
+ "get": {
+ "tags": [
+ "JobQueue"
+ ],
+ "summary": "Get the processing configuration.",
+ "operationId": "GetProcessingConfig",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsProcessingConfig"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsProcessingConfig"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsProcessingConfig"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoCreateRecordListItemsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateRecordListItemsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateRecordListItemsInfo"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateRecordListItemsInfo"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoDeleteRecordListItems"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoDeleteRecordListItems"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoDeleteRecordListItems"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoDeleteRecordListItems"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListItemsInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeadersInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeadersInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeadersInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoCreateRecordList"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateRecordList"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateRecordList"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateRecordList"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListSearchResultsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchResultsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchResultsInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoUpdateRecordListProperties"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListProperties"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListProperties"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListProperties"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoUserPermission"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermission"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermission"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoUserPermission"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermission"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermission"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list not found"
+ }
+ }
+ }
+ },
+ "/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",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionsInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiListsDtoUpdateUserPermissionsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateUserPermissionsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateUserPermissionsInfo"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateUserPermissionsInfo"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermissionsInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list or user or group not found"
+ }
+ }
+ }
+ },
+ "/api/v1/lists/list/{listIdentifier}/permissions/user/{userIdentifier}": {
+ "get": {
+ "tags": [
+ "ListPermissions"
+ ],
+ "summary": "Gets the permission flags of the permission associating the specified list with the specified user.",
+ "operationId": "GetPermissionsForUser",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "userIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlags"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlags"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlags"
+ }
+ }
+ }
+ },
+ "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",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "userIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListPermissionFlags"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListPermissionFlags"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListPermissionFlags"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListPermissionFlags"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlags"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlags"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlags"
+ }
+ }
+ }
+ },
+ "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",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiMetricsGetJobsSummaryResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiMetricsGetJobsSummaryResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiMetricsGetJobsSummaryResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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",
+ "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": "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/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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":"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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "record-history-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/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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":"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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesCreateRecordHistory"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"ac937e28-2e69-4b79-a8eb-51a7fff4b4ab"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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/GrantaServerApiRecordsRecordHistoriesCreateRecordHistory"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"ac937e28-2e69-4b79-a8eb-51a7fff4b4ab"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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"}}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesCreateRecordHistory"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"ac937e28-2e69-4b79-a8eb-51a7fff4b4ab"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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/GrantaServerApiRecordsRecordHistoriesCreateRecordHistory"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"ac937e28-2e69-4b79-a8eb-51a7fff4b4ab"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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"}}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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":"39fe1d39-3391-484d-9a03-3f35c9165d99"}],"subsets":[],"guid":"c604da82-3b1c-4418-a5b0-2d3549b54585"}
+ }
+ }
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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/GrantaServerApiExceptionsRecordHistoryRecordHistoryMoveException"
+ },
+ "examples": {
+ "Example 11": {
+ "summary": "New parent is not a folder.",
+ "value": {"message":"Cannot move record history 'ba22491d-b470-42cf-80d7-531ff81b1583'.","code":400,"errors":[{"message":"New parent record history '17877254-3a26-4a28-94d6-9f6be164914c' is not a folder.","reason":"ParentNotAFolder"}]}
+ },
+ "Example 12": {
+ "summary": "New parent is not in the same table.",
+ "value": {"message":"Cannot move record history '0a0a07f6-20d8-4292-a275-a7385398d8a2'.","code":400,"errors":[{"message":"New parent record history '5a842e54-e143-45f5-aec8-18fb84f4fe03' is not in the same table.","reason":"ParentNotInSameTable"}]}
+ },
+ "Example 13": {
+ "summary": "The 'short name' of the record to be moved is not unique under the new parent.",
+ "value": {"message":"Cannot move record history '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 14": {
+ "summary": "New parent is withdrawn.",
+ "value": {"message":"Cannot move record history 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.","code":400,"errors":[{"message":"New parent record history '4afa8a76-cd32-4835-be9d-31756bb9b7fb' is withdrawn or has a withdrawn ancestor.","reason":"ParentIsWithdrawn"}]}
+ },
+ "Example 15": {
+ "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 '5a842e54-e143-45f5-aec8-18fb84f4fe03'.","code":400,"errors":[{"message":"New parent record history 'ba22491d-b470-42cf-80d7-531ff81b1583' is a descendant so will cause a circular reference.","reason":"ParentIsADescendant"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "record-history-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiRecordsRecordHistoriesMoveRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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/GrantaServerApiExceptionsRecordHistoryRecordHistoryMoveException"
+ },
+ "examples": {
+ "Example 16": {
+ "summary": "New parent is not a folder.",
+ "value": {"message":"Cannot move record history 'ba22491d-b470-42cf-80d7-531ff81b1583'.","code":400,"errors":[{"message":"New parent record history '17877254-3a26-4a28-94d6-9f6be164914c' is not a folder.","reason":"ParentNotAFolder"}]}
+ },
+ "Example 17": {
+ "summary": "New parent is not in the same table.",
+ "value": {"message":"Cannot move record history '0a0a07f6-20d8-4292-a275-a7385398d8a2'.","code":400,"errors":[{"message":"New parent record history '5a842e54-e143-45f5-aec8-18fb84f4fe03' is not in the same table.","reason":"ParentNotInSameTable"}]}
+ },
+ "Example 18": {
+ "summary": "The 'short name' of the record to be moved is not unique under the new parent.",
+ "value": {"message":"Cannot move record history '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 19": {
+ "summary": "New parent is withdrawn.",
+ "value": {"message":"Cannot move record history 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.","code":400,"errors":[{"message":"New parent record history '4afa8a76-cd32-4835-be9d-31756bb9b7fb' is withdrawn or has a withdrawn ancestor.","reason":"ParentIsWithdrawn"}]}
+ },
+ "Example 20": {
+ "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 '5a842e54-e143-45f5-aec8-18fb84f4fe03'.","code":400,"errors":[{"message":"New parent record history 'ba22491d-b470-42cf-80d7-531ff81b1583' is a descendant so will cause a circular reference.","reason":"ParentIsADescendant"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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 9": {
+ "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/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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 9": {
+ "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/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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 9": {
+ "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/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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 9": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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":"a1d0aea2-35e1-4486-ae75-e1ecaf4b394a"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsRecordHistoryRecordHistoryCopyException"
+ },
+ "examples": {
+ "Example 9": {
+ "summary": "New parent is not a folder.",
+ "value": {"message":"Cannot copy record history 'ba22491d-b470-42cf-80d7-531ff81b1583'.","code":400,"errors":[{"message":"New parent record history '17877254-3a26-4a28-94d6-9f6be164914c' is not a folder.","reason":"ParentNotAFolder"}]}
+ },
+ "Example 10": {
+ "summary": "New parent is not in the same table.",
+ "value": {"message":"Cannot copy record history '0a0a07f6-20d8-4292-a275-a7385398d8a2'.","code":400,"errors":[{"message":"New parent record history '5a842e54-e143-45f5-aec8-18fb84f4fe03' is not in the same table.","reason":"ParentNotInSameTable"}]}
+ },
+ "Example 11": {
+ "summary": "The 'short name' of the record to be copied is not unique under the new parent.",
+ "value": {"message":"Cannot copy record history '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 12": {
+ "summary": "New parent is withdrawn.",
+ "value": {"message":"Cannot copy record history 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.","code":400,"errors":[{"message":"New parent record history '4afa8a76-cd32-4835-be9d-31756bb9b7fb' is withdrawn or has a withdrawn ancestor.","reason":"ParentIsWithdrawn"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "record-history-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 10": {
+ "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 11": {
+ "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 12": {
+ "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/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 10": {
+ "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 11": {
+ "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 12": {
+ "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/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 10": {
+ "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 11": {
+ "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 12": {
+ "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/GrantaServerApiRecordsRecordHistoriesCopyRecordHistory"
+ },
+ "examples": {
+ "Example 10": {
+ "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 11": {
+ "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 12": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesRecordHistory"
+ },
+ "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":"cebdfb04-8c64-4b9d-9cd8-8edc02d82d7a"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsRecordHistoryRecordHistoryCopyException"
+ },
+ "examples": {
+ "Example 13": {
+ "summary": "New parent is not a folder.",
+ "value": {"message":"Cannot copy record history 'ba22491d-b470-42cf-80d7-531ff81b1583'.","code":400,"errors":[{"message":"New parent record history '17877254-3a26-4a28-94d6-9f6be164914c' is not a folder.","reason":"ParentNotAFolder"}]}
+ },
+ "Example 14": {
+ "summary": "New parent is not in the same table.",
+ "value": {"message":"Cannot copy record history '0a0a07f6-20d8-4292-a275-a7385398d8a2'.","code":400,"errors":[{"message":"New parent record history '5a842e54-e143-45f5-aec8-18fb84f4fe03' is not in the same table.","reason":"ParentNotInSameTable"}]}
+ },
+ "Example 15": {
+ "summary": "The 'short name' of the record to be copied is not unique under the new parent.",
+ "value": {"message":"Cannot copy record history '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 16": {
+ "summary": "New parent is withdrawn.",
+ "value": {"message":"Cannot copy record history 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.","code":400,"errors":[{"message":"New parent record history '4afa8a76-cd32-4835-be9d-31756bb9b7fb' is withdrawn or has a withdrawn ancestor.","reason":"ParentIsWithdrawn"}]}
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or record history not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/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 and table.",
+ "operationId": "GetLatestRecordVersionFromTable",
+ "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": "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/GrantaServerApiRecordsRecordVersionsRecordVersion"
+ },
+ "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Alumino silicate - 1720","recordColor":"fuchsia","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",
+ "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/GrantaServerApiRecordsRecordVersionsRecordVersion"
+ },
+ "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Alumino silicate - 1720","recordColor":"fuchsia","versionNumber":1,"versionState":"unversioned","name":"Alumino silicate - 1720","guid":"00000026-000e-4fff-8fff-dd92ffff0000"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or record history not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}": {
+ "get": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "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",
+ "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": "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/GrantaServerApiRecordsRecordVersionsRecordVersion"
+ },
+ "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Alumino silicate - 1720","recordColor":"fuchsia","versionNumber":1,"versionState":"unversioned","name":"Alumino silicate - 1720","guid":"00000026-000e-4fff-8fff-dd92ffff0000"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table, record history or record version 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",
+ "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"
+ }
+ }
+ ],
+ "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": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "summary": "Releases the record version. Must be an unreleased record version.",
+ "operationId": "ReleaseRecordVersion",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordVersionsRecordVersion"
+ },
+ "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Arsenic trioxide [1327-53-3]","recordColor":"red","versionNumber":1,"versionState":"released","name":"Arsenic trioxide [1327-53-3]","guid":"e1a72a7e-155e-47f9-b6c9-285fd5d3288a"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Record version state is not unreleased, or table is not version controlled, or parent is not released.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlReleaseRecordVersionControlException"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Invalid version state.",
+ "description": "Only unreleased record versions can be released.",
+ "value": {"message":"Cannot release record version 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.","code":400,"errors":[{"message":"Invalid version state 'Released'.","reason":"invalidVersionState","versionState":"released"}]}
+ },
+ "Example 5": {
+ "summary": "Table is not version controlled.",
+ "value": {"message":"Cannot release record version '00000026-000e-4fff-8fff-dd92ffff0000'.","code":400,"errors":[{"message":"Table is not version controlled.","reason":"notVersioned"}]}
+ },
+ "Example 6": {
+ "summary": "Parent is not released.",
+ "value": {"message":"Cannot release record version 'c74510af-3456-4fb9-8446-4db42811a0fc'.","code":400,"errors":[{"message":"Tree parent is not in a valid state to perform this operation.","reason":"invalidParentState"}]}
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "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}:get-modifiable-version": {
+ "post": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "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": "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"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordVersionsRecordVersion"
+ },
+ "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Arsenic trioxide [1327-53-3]","recordColor":"red","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/GrantaServerApiExceptionsVersionControlGetModifiableRecordVersionControlException"
+ },
+ "examples": {
+ "Example 4": {
+ "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 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.","code":400,"errors":[{"message":"Invalid version state 'Superseded'.","reason":"invalidVersionState","versionState":"superseded"}]}
+ },
+ "Example 5": {
+ "summary": "Table is not version controlled.",
+ "value": {"message":"Cannot create a new version from the record version '00000026-000e-4fff-8fff-dd92ffff0000'.","code":400,"errors":[{"message":"Table is not version controlled.","reason":"notVersioned"}]}
+ },
+ "Example 6": {
+ "summary": "Record version is not the latest version.",
+ "value": {"message":"Cannot create a new version from the record version '54ce0d31-6bba-4b6f-953a-eaf21d19281b'.","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":"f3bf05d9-867f-4ba8-8cb7-7451932921ed"}}]}
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "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}:withdraw": {
+ "post": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "summary": "Withdraws the record version. Must be a released record version.",
+ "operationId": "WithdrawRecordVersion",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordVersionsRecordVersion"
+ },
+ "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Arsenic trioxide [1327-53-3]","recordColor":"red","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/GrantaServerApiExceptionsVersionControlWithdrawRecordVersionControlException"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Invalid version state.",
+ "description": "Only released record versions can be withdrawn.",
+ "value": {"message":"Cannot withdraw record version 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.","code":400,"errors":[{"message":"Invalid version state 'Unreleased'.","reason":"invalidVersionState","versionState":"unreleased"}]}
+ },
+ "Example 4": {
+ "summary": "Table is not version controlled.",
+ "value": {"message":"Cannot withdraw record version '00000026-000e-4fff-8fff-dd92ffff0000'.","code":400,"errors":[{"message":"Table is not version controlled.","reason":"notVersioned"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table, record history or record version not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/schema/mi-version": {
+ "get": {
+ "tags": [
+ "Schema"
+ ],
+ "summary": "Returns the currently running MI version to the caller.",
+ "operationId": "GetVersion",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiAdminMiVersion"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get all attributes in table",
+ "operationId": "GetAttributes",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Create a new attribute.",
+ "operationId": "CreateAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"39fc91dd-0928-4667-b7f5-f2bf7cbb795c"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"39fc91dd-0928-4667-b7f5-f2bf7cbb795c"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"39fc91dd-0928-4667-b7f5-f2bf7cbb795c"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ "examples": {
+ "Example 25": {
+ "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 26": {
+ "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":"39fc91dd-0928-4667-b7f5-f2bf7cbb795c"}
+ },
+ "Example 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 45": {
+ "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":[{"parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"},"defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"}],"isRange":true,"defaultThresholdType":"atLeast","name":"Electrical resistance with temperature"}
+ },
+ "Example 46": {
+ "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":[{"parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}],"defaultThresholdType":"equal","name":"Environmental resistance"}
+ },
+ "Example 47": {
+ "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"}],"expressions":[{"guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}],"allowExtrapolation":false,"isRange":false,"allowAllCompatibleExpressions":false,"allowAnonymousExpressions":false,"defaultThresholdType":"equal","name":"Fatigue strength model"}
+ },
+ "Example 48": {
+ "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": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"discrete","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":[]},"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": {"type":"range","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":[{"name":"Tensile strength [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":"1629f29a-05d9-49db-a339-62da057dafd9"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"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 table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get attribute in table",
+ "operationId": "GetAttribute",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"discrete","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":[]},"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": {"type":"range","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":[{"name":"Tensile strength [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":"4b69303d-25a3-4ced-9c61-4e32dab87858"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"displayNames":{},"name":"Restricted substances associated with this material","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Update attribute.",
+ "operationId": "UpdateAttribute",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 22": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 23": {
+ "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 24": {
+ "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 25": {
+ "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 26": {
+ "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":[{"parameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","defaultValue":5.0,"interpolationMethod":"auto","scaleType":"notSet"},{"parameterGuid":"00000005-000a-4fff-8fff-0000ffff0000","interpolationMethod":"linear","scaleType":"logarithmic"},{"parameterGuid":"7a6ccb7b-8a47-4cab-8203-c741d476560f","interpolationMethod":"none","scaleType":"linear"}]}
+ },
+ "Example 27": {
+ "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 28": {
+ "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": {"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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "examples": {
+ "Example 29": {
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{"fr":"Casting Date French Display Name"},"name":"Casting Date","guid":"fe9cbde6-756a-4b1d-a347-7d49e56ee90f"}
+ },
+ "Example 30": {
+ "summary": "Discrete attribute",
+ "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"discrete","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":[]},"displayNames":{},"name":"Metals","guid":"0000000b-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 31": {
+ "summary": "Range attribute",
+ "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"range","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":[{"name":"Tensile strength [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":"78d1ab71-772d-4d1f-828d-eec3f12f1d09"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 32": {
+ "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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"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 or attribute not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Delete an attribute.",
+ "operationId": "DeleteAttribute",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request. Attribute in use.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDeletionAttributeDeletionException"
+ },
+ "example": {"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":"inUse","referencedByType":"versionControlledData"},{"message":"It is being used in one or more expressions.","reason":"inUse","referencedByType":"expression","referencedBy":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}]}
+ }
+ }
+ },
+ "200": {
+ "description": "Ok"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get all meta-attributes in table",
+ "operationId": "GetMetaAttributes",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get meta-attribute in table",
+ "operationId": "GetMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"discrete","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":[]},"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": {"type":"range","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":[{"name":"Tensile strength [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":"435c2a30-7dd8-48a1-90db-10d2a6c54cd9"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"displayNames":{},"name":"Restricted substances associated with this material","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or meta-attribute not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Update meta-attribute.",
+ "operationId": "UpdateMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ "examples": {
+ "Example 37": {
+ "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": {"type":"dateTime","defaultThresholdType":"atLeast","info":{"typeCode":"DAT","chartable":false,"expressionable":false,"linkable":true,"extendedName":"Casting Date","isMetaAttribute":false,"orderedMetaAttributes":[],"primaryDataLinkGroups":[],"foreignDataLinkGroups":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{"fr":"Casting Date French Display Name"},"name":"Casting Date","guid":"fe9cbde6-756a-4b1d-a347-7d49e56ee90f"}
+ },
+ "Example 38": {
+ "summary": "Discrete attribute",
+ "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"discrete","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":[]},"displayNames":{},"name":"Metals","guid":"0000000b-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 39": {
+ "summary": "Range attribute",
+ "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.",
+ "value": {"type":"range","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":[{"name":"Tensile strength [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":"66f20f3a-fcb0-47b3-bd0b-45d65979c6e7"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"displayNames":{},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 40": {
+ "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": {"type":"link","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","name":"Chemical name","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07"},"showAsLink":true,"summaryRowEnabled":false,"summaryRowText":"","rollUpType":"list","summaryRowRollUpType":"list","displayNames":{},"name":"Substance name","guid":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"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":"fdbfaa62-61ff-43de-9ecb-3728ce83cb4e"},{"columnType":"linkedColumn","linkedAttribute":{"type":"link","name":"Legislations restricting its use","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc"},"linkedColumn":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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":[]},"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 or meta-attribute not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Delete a meta-attribute.",
+ "operationId": "DeleteMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDeletionAttributeDeletionException"
+ },
+ "example": {"message":"Cannot delete attribute 'Notes' (GUID = 'ec524e34-34bb-4a4d-be2d-d6eb2f53591b').","code":400,"errors":[{"message":"It is being used in version controlled data.","reason":"inUse","referencedByType":"versionControlledData"},{"message":"It is being used in one or more search masks.","reason":"inUse","referencedByType":"searchMask","referencedBy":[{"name":"Search mask that searches in Notes","guid":"30d50fa0-34d2-420f-8876-c7b2fc90f4cc"}]}]}
+ }
+ }
+ },
+ "200": {
+ "description": "OK"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or meta-attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get meta-attributes for attribute",
+ "operationId": "GetMetaAttributesForAttribute",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}:validate": {
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Validates the provided value against the attributes data rules.",
+ "operationId": "ValidateAttribute",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeValidateResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}:validate": {
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Validates the provided value against the meta attributes data rules.",
+ "operationId": "ValidateMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesValidateAttributeRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeValidateResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or meta-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"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfigurationsInfo"
+ },
+ "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"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"0ca53c0f-0bcb-4c44-b3af-ad842fd2c3db"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"0ca53c0f-0bcb-4c44-b3af-ad842fd2c3db"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"0ca53c0f-0bcb-4c44-b3af-ad842fd2c3db"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Configuration",
+ "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.",
+ "value": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"description":"Basic configuration that can be used in explore.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"basic configuration","guid":"0ca53c0f-0bcb-4c44-b3af-ad842fd2c3db"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfiguration"
+ },
+ "example": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples","guid":"997e8f58-bd2a-494f-9a99-18b3d395ad0a"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Get individual configuration",
+ "operationId": "GetConfiguration",
+ "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"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "configuration-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfiguration"
+ },
+ "example": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples","guid":"997e8f58-bd2a-494f-9a99-18b3d395ad0a"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or configuration not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Update a configuration.",
+ "operationId": "UpdateConfiguration",
+ "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"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "configuration-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"eb1a25ed-aa75-4346-a2f8-228f62189250"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"eb1a25ed-aa75-4346-a2f8-228f62189250"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"eb1a25ed-aa75-4346-a2f8-228f62189250"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"description":"Updated description for MI_Training Explore 'examples' configuration.","value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","name":"examples (updated)","guid":"eb1a25ed-aa75-4346-a2f8-228f62189250"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConfigurationsConfiguration"
+ },
+ "example": {"value":"{\n\t\"configurations\": [\n\t{\n\t\t\t\"key\": \"training-materials\",\n\t\t\t\"displayName\": \"MI Training Materials\",\n\t\t\t\"default\": true,\n\t\t\t\"groups\": [\n\t\t\t\t\"MI Training examples\"\n\t\t\t],\n\t\t\t\"table\": \"MaterialUniverse\",\n\t\t\t\"loadDataOnDemand\": false,\n\t\t\t\"description\": \"Explore MaterialUniverse data in the MI Training database\",\n\t\t\t\"searchLayout\": \"All bulk materials\",\n\t\t\t\"dataSheetLayout\": \"All bulk materials\",\n\t\t\t\"editableDatasheetLayout\": \"All bulk materials\",\n\t\t\t\"searchListLayout\": \"Explore list layout Materials\",\n\t\t\t\"newRecordLocation\": \"NEW RECORDS/{Base}\",\n\t\t\t\"subset\": \"All bulk materials\",\n\t\t\t\"logsliders\": true,\n\t\t\t\"xyChart\": {\n\t\t\t\t\"colorAttribute\": \"UV radiation (sunlight)\",\n\t\t\t\t\"colorAttribute2\": \"Flammability\",\n\t\t\t\t\"colorAttribute3\": \"Food contact\",\n\t\t\t\t\"colorAttribute4\": \"Material form\",\n\t\t\t\t\"colorAttribute5\": \"Organic solvents\",\n\t\t\t\t\"colorAttribute6\": \"Oxidation at 500C\",\n\t\t\t\t\"colorAttribute7\": \"Strong acids\",\n\t\t\t\t\"colorAttribute8\": \"Strong alkalis\",\n\t\t\t\t\"colorAttribute9\": \"Weak acids\",\n\t\t\t\t\"colorAttribute10\": \"Weak alkalis\",\n\t\t\t\t\"colorAttribute11\": \"Water (fresh)\",\n\t\t\t\t\"colorAttribute12\": \"Water (salt)\",\n\t\t\t\t\"colorAttribute13\": \"Transparency\",\n\t\t\t\t\"colorAttribute14\": \"Wear resistance\",\n\t\t\t\t\"xAttribute\": \"Density\",\n\t\t\t\t\"yAttribute\": \"Yield strength (elastic limit)\",\n\t\t\t\t\"preventAxisChange\": false,\n\t\t\t\t\"xAxisLogarithmic\": true,\n\t\t\t\t\"yAxisLogarithmic\": true\n\t\t\t},\n\t\t\t\"showBlanks\": false,\n\t\t\t\"reportsDisabled\": false,\n\t\t\t\"exportersDisabled\": false,\n\t\t\t\"tabularEditingEnabled\": true,\n\t\t\t\"configSwitching\": \"keyOnly\",\n\t\t\t\"workflowEnabled\": true,\n\t\t\t\"useCustomFormatters\": {\n\t\t\t\t\"Recycle fraction in current supply\": \"recyclingPercent\",\n\t\t\t\t\"Recycle\": \"recyclingBool\",\n\t\t\t\t\"Biodegrade\": \"biodegradeBool\",\n\t\t\t\t\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\n\t\t\t\t\"Flammability\": \"flammabilityDiscrete\",\n\t\t\t\t\"Food contact\": \"foodcontactDiscrete\",\n\t\t\t\t\"Material form\": \"materialformDiscrete\",\n\t\t\t\t\"Organic solvents\": \"organicsolventsDiscrete\",\n\t\t\t\t\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\n\t\t\t\t\"Strong acids\": \"strongacidsDiscrete\",\n\t\t\t\t\"Strong alkalis\": \"strongalkalisDiscrete\",\n\t\t\t\t\"Weak acids\": \"weakacidsDiscrete\",\n\t\t\t\t\"Weak alkalis\": \"weakalkalisDiscrete\",\n\t\t\t\t\"Water (fresh)\": \"waterfreshDiscrete\",\n\t\t\t\t\"Water (salt)\": \"watersaltDiscrete\",\n\t\t\t\t\"Transparency\": \"transparencyDiscrete\",\n\t\t\t\t\"Wear resistance\": \"wearresistanceDiscrete\",\n\t\t\t\t\"A renewable resource?\": \"arenewableresourceBool\",\n\t\t\t\t\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\n\t\t\t\t\"Downcycle\": \"downcycleBool\",\n\t\t\t\t\"Flame retardant additive\": \"flameretardantadditiveBool\",\n\t\t\t\t\"Landfill\": \"landfillBool\",\n\t\t\t\t\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\n\t\t\t\t\"Substance declaration available?\": \"substancedeclarationavailableBool\"\n\t\t\t}\n\t\t}\n\t],\n\t\"customFormatterDefinitions\": {\n\t\t\"recyclingBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be recycled\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"biodegradeBool\": {\n\t\t\t\"attributeFormatter\": {\n\t\t\t\t\"list\": {\n\t\t\t\t\t\"columnHeader\": false,\n\t\t\t\t\t\"columnWidth\": 40\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"valueFormatters\": [{\n\t\t\t\t\t\"match\": true,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"green\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"match\": false,\n\t\t\t\t\t\"list\": {\n\t\t\t\t\t\t\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\n\t\t\t\t\t\t\"tooltipValue\": \"Can not be biodegraded\"\n\t\t\t\t\t},\n\t\t\t\t\t\"chart\": {\n\t\t\t\t\t\t\"renderColor\": \"red\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}","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"
+ ],
+ "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"
+ ],
+ "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/GrantaServerApiSchemaConstantsConstantsInfo"
+ },
+ "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/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"a07a7892-14dd-42e1-a5f1-457796a58495"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum (guid and unit)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"a07a7892-14dd-42e1-a5f1-457796a58495"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum (guid and unit)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"a07a7892-14dd-42e1-a5f1-457796a58495"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum (guid and unit)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"a07a7892-14dd-42e1-a5f1-457796a58495"}
+ },
+ "Example 6": {
+ "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": {"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/GrantaServerApiSchemaConstantsConstant"
+ },
+ "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 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/GrantaServerApiSchemaConstantsConstant"
+ },
+ "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/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"6df1c3ec-da09-4cd5-bb40-e04eb56609d4"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"f9710c60-f4a0-4589-a1eb-ea4015f28671"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"6df1c3ec-da09-4cd5-bb40-e04eb56609d4"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"f9710c60-f4a0-4589-a1eb-ea4015f28671"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"6df1c3ec-da09-4cd5-bb40-e04eb56609d4"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"f9710c60-f4a0-4589-a1eb-ea4015f28671"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"6df1c3ec-da09-4cd5-bb40-e04eb56609d4"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"f9710c60-f4a0-4589-a1eb-ea4015f28671"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaConstantsConstant"
+ },
+ "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/GrantaServerApiExceptionsDeletionConstantDeletionException"
+ },
+ "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":"inUse","referencedByType":"expression","referencedBy":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}]}
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaDataRulesDataRulesInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/data-rules/{data-rule-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Gets a data rule for a given database and guid.",
+ "operationId": "GetDataRule",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "data-rule-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or data rule not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Edit a data rule",
+ "operationId": "UpdateDataRule",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "data-rule-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesUpdateDataRule"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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."
+ }
+ }
+ }
+ },
+ "/v1alpha/databases": {
+ "get": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Lists all databases that the user can see.",
+ "operationId": "GetAllDatabases",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabasesInfo"
+ },
+ "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"}]}
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}": {
+ "get": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Returns details for a given database.",
+ "operationId": "GetDatabase",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"4599bf3c-3aec-4f4f-b39b-333df08a5f06","name":"MI Training (Updated)","guid":"75087304-ff94-4e5d-aac7-a3b73fe30a35"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"4599bf3c-3aec-4f4f-b39b-333df08a5f06","name":"MI Training (Updated)","guid":"75087304-ff94-4e5d-aac7-a3b73fe30a35"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"4599bf3c-3aec-4f4f-b39b-333df08a5f06","name":"MI Training (Updated)","guid":"75087304-ff94-4e5d-aac7-a3b73fe30a35"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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.\r\n\r\n\nThis 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":"4599bf3c-3aec-4f4f-b39b-333df08a5f06","name":"MI Training (Updated)","guid":"75087304-ff94-4e5d-aac7-a3b73fe30a35"}
+ },
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database not found."
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:lock": {
+ "post": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Lock database",
+ "operationId": "LockDatabase",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "Database to lock",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database not found."
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:unlock": {
+ "post": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Unlock database",
+ "operationId": "UnlockDatabase",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "Database to unlock",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDatabase"
+ }
+ }
+ }
+ },
+ "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": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteTypesInfo"
+ }
+ }
+ }
+ },
+ "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",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaDiscreteTypesCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ }
+ }
+ }
+ },
+ "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": "discrete-type-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database or discrete type not found."
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Discrete Types"
+ ],
+ "summary": "Delete discrete type, including all of its discrete values.",
+ "operationId": "DeleteDiscreteType",
+ "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": {
+ "400": {
+ "description": "Bad request. Discrete type in use by Attributes.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDeletionDiscreteTypeDeletionException"
+ },
+ "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":"inUse","referencedByType":"attribute","referencedBy":[{"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",
+ "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/GrantaServerApiSchemaSlimEntitiesSlimObjects"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "404": {
+ "description": "Database or discrete type 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. If discreteType is ordered, then discreteValues will be return in order, otherwise order is not deterministic.",
+ "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/GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or discrete type not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - DiscreteTypes - DiscreteValues"
+ ],
+ "summary": "Create new discrete value. If it's ordered, 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/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c7e387d7-dd6e-4fea-9900-3046acacc5b3"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c7e387d7-dd6e-4fea-9900-3046acacc5b3"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c7e387d7-dd6e-4fea-9900-3046acacc5b3"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c7e387d7-dd6e-4fea-9900-3046acacc5b3"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or discrete type not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values/{discrete-value-guid}": {
+ "get": {
+ "tags": [
+ "Schema - DiscreteTypes - DiscreteValues"
+ ],
+ "summary": "Gets specific discrete value for a given discreteType within a given database.",
+ "operationId": "GetDiscreteValue",
+ "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": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, discrete type or discrete value not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - DiscreteTypes - DiscreteValues"
+ ],
+ "summary": "Update discrete value.",
+ "operationId": "UpdateDiscreteValue",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiExceptionsDeletionDiscreteValueDeletionException"
+ },
+ "example": {"message":"Cannot delete discrete value 'Unacceptable' (GUID = '00000583-0007-4fff-8fff-0083ffff0000').","code":400,"errors":[{"message":"It is being used in one or more data items.","reason":"inUse","referencedByType":"data"}]}
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","name":"Abaqus","guid":"41aba877-8fe0-4295-bddb-6f8b270a40ff"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","name":"Abaqus","guid":"41aba877-8fe0-4295-bddb-6f8b270a40ff"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"e8cfe67a-ca6e-4e86-bc97-fb988243bd80"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"e8cfe67a-ca6e-4e86-bc97-fb988243bd80"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"e8cfe67a-ca6e-4e86-bc97-fb988243bd80"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"e8cfe67a-ca6e-4e86-bc97-fb988243bd80"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"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 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",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesExporterRefetchInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesExporterRefetchInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesExporterRefetchInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/exporters/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Move an existing Exporter Folder.",
+ "operationId": "MoveExportersFolder",
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"7aab3465-69af-47a9-a345-8d4ab0870aed"},{"name":"no-transform.xslt","guid":"948b9999-000d-4789-8ff9-ebb131e66ebf"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"7aab3465-69af-47a9-a345-8d4ab0870aed"},{"name":"no-transform.xslt","guid":"948b9999-000d-4789-8ff9-ebb131e66ebf"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"7aab3465-69af-47a9-a345-8d4ab0870aed"},{"name":"no-transform.xslt","guid":"948b9999-000d-4789-8ff9-ebb131e66ebf"}]}
+ }
+ }
+ },
+ "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": {
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"7803eaa3-f276-4719-aeae-072b8dbc7856"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"7803eaa3-f276-4719-aeae-072b8dbc7856"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"7803eaa3-f276-4719-aeae-072b8dbc7856"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"0d1693e6-56f9-4e0a-a4a0-08bca06e0713"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"0d1693e6-56f9-4e0a-a4a0-08bca06e0713"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"0d1693e6-56f9-4e0a-a4a0-08bca06e0713"}
+ }
+ }
+ },
+ "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",
+ "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/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"2e0ae68b-085c-4936-8df2-567e18c35512"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"2e0ae68b-085c-4936-8df2-567e18c35512"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"2e0ae68b-085c-4936-8df2-567e18c35512"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"2e0ae68b-085c-4936-8df2-567e18c35512"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"bab0c009-70c3-49c9-800c-17629e557d24"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"bab0c009-70c3-49c9-800c-17629e557d24"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"bab0c009-70c3-49c9-800c-17629e557d24"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ },
+ "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": "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"
+ },
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"fd8febd4-713a-42e5-9e99-0e09b4c67f3b"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"fd8febd4-713a-42e5-9e99-0e09b4c67f3b"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"fd8febd4-713a-42e5-9e99-0e09b4c67f3b"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions": {
+ "get": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Get all expressions for table",
+ "operationId": "GetExpressions",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpressionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Create a new expression.",
+ "operationId": "CreateExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"85d538d6-295e-4f32-b54a-b7a4fe7a8586"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"85d538d6-295e-4f32-b54a-b7a4fe7a8586"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"85d538d6-295e-4f32-b54a-b7a4fe7a8586"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaExpressionsCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"85d538d6-295e-4f32-b54a-b7a4fe7a8586"}
+ },
+ "Example 6": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpression"
+ },
+ "examples": {
+ "Example 5": {
+ "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":[{"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"name":"Fatigue strength at 10^7 cycles","guid":"0000010c-0001-4fff-8fff-dd92ffff0000"},{"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"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"}
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Get an expression with a specified guid for a given database and table.",
+ "operationId": "GetExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "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": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpression"
+ },
+ "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":[{"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"name":"Fatigue strength at 10^7 cycles","guid":"0000010c-0001-4fff-8fff-dd92ffff0000"},{"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"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"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or expression not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Update an expression.",
+ "operationId": "UpdateExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "expression-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"d041546a-a8f3-4848-bfd5-5d271c0725cc"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"d041546a-a8f3-4848-bfd5-5d271c0725cc"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"d041546a-a8f3-4848-bfd5-5d271c0725cc"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"d041546a-a8f3-4848-bfd5-5d271c0725cc"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaExpressionsExpression"
+ },
+ "examples": {
+ "Example 6": {
+ "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":[{"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"name":"Fatigue strength at 10^7 cycles","guid":"0000010c-0001-4fff-8fff-dd92ffff0000"},{"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"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"}
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or expression not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Delete an expression.",
+ "operationId": "DeleteExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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/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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Create a new Help File Folder.",
+ "operationId": "CreateHelpFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/help-folders/:root-folder": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Root Help File Folder",
+ "operationId": "GetHelpRootFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Help Pages","guid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Help Pages","guid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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": "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/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"html","guid":"99ff4816-15e9-42b9-9ac3-b60fce881e85"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"html","guid":"99ff4816-15e9-42b9-9ac3-b60fce881e85"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"html","guid":"99ff4816-15e9-42b9-9ac3-b60fce881e85"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Update an existing Help File Folder.",
+ "operationId": "UpdateHelpFolder",
+ "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/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"5cb6ba30-5f5d-4581-974e-f5c5b81a79bf"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"5cb6ba30-5f5d-4581-974e-f5c5b81a79bf"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"5cb6ba30-5f5d-4581-974e-f5c5b81a79bf"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"5cb6ba30-5f5d-4581-974e-f5c5b81a79bf"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Delete a Help File Folder.",
+ "operationId": "DeleteHelpFolder",
+ "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}/help-folders/{folder-guid}:child-folders": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Child Help File Folders",
+ "operationId": "GetHelpChildFolders",
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "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 or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Move an existing Help File Folder.",
+ "operationId": "MoveHelpFolder",
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/help-folders/{folder-guid}/files": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Files in a Folder",
+ "operationId": "GetHelpFiles",
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"ca5c502c-eae5-4cf1-8f06-1126b3b84cb4"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"ca5c502c-eae5-4cf1-8f06-1126b3b84cb4"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"ca5c502c-eae5-4cf1-8f06-1126b3b84cb4"}
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "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 - Help Files"
+ ],
+ "summary": "Update an existing Help File.",
+ "operationId": "UpdateHelpFile",
+ "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/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"b1075024-1276-4b09-848e-ed9fc618d077"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"b1075024-1276-4b09-848e-ed9fc618d077"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"b1075024-1276-4b09-848e-ed9fc618d077"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"b1075024-1276-4b09-848e-ed9fc618d077"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"c842f95d-bd64-42f8-8cf5-cf85fabbc9c6"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"c842f95d-bd64-42f8-8cf5-cf85fabbc9c6"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"c842f95d-bd64-42f8-8cf5-cf85fabbc9c6"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file 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",
+ "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"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Move an existing Help File.",
+ "operationId": "MoveHelpFile",
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"577b549c-74f2-4a3d-ad9c-27927c3bb9e3"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"577b549c-74f2-4a3d-ad9c-27927c3bb9e3"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"577b549c-74f2-4a3d-ad9c-27927c3bb9e3"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get All Home Page Folders",
+ "operationId": "GetHomePageFolders",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"},{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"4953183d-d1d7-46db-a360-cf4e57f39634"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"},{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"4953183d-d1d7-46db-a360-cf4e57f39634"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"},{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"4953183d-d1d7-46db-a360-cf4e57f39634"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Create a new Home Page Folder.",
+ "operationId": "CreateHomePageFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/home-page-folders:root-folder": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Root Home Page Folder",
+ "operationId": "GetHomePageRootFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"}
+ }
+ }
+ },
+ "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",
+ "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/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"7b10cc6b-7e0d-4b71-b6d1-ff598b597615"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"7b10cc6b-7e0d-4b71-b6d1-ff598b597615"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"7b10cc6b-7e0d-4b71-b6d1-ff598b597615"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Update an existing Home Page Folder.",
+ "operationId": "UpdateHomePageFolder",
+ "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/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"d7d3a50f-8bd0-49c8-8ac6-dab591b9be16"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"d7d3a50f-8bd0-49c8-8ac6-dab591b9be16"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"d7d3a50f-8bd0-49c8-8ac6-dab591b9be16"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"d7d3a50f-8bd0-49c8-8ac6-dab591b9be16"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Delete a Home Page Folder.",
+ "operationId": "DeleteHomePageFolder",
+ "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}/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",
+ "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/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"c85f1acf-61c8-438d-88e6-591450ff54dd"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"c85f1acf-61c8-438d-88e6-591450ff54dd"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"c85f1acf-61c8-438d-88e6-591450ff54dd"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Move an existing Home Page Folder.",
+ "operationId": "MoveHomePageFolder",
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "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}/home-page-folders/{folder-guid}/files": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get the Home Page Files in a Folder",
+ "operationId": "GetHomePageFiles",
+ "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/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"8db7ce85-25d3-4c7c-97a5-29dba05549b6"},{"name":"home-page-2.html","guid":"ef4193c1-7cda-43b5-96c9-80057f0fdce0"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"8db7ce85-25d3-4c7c-97a5-29dba05549b6"},{"name":"home-page-2.html","guid":"ef4193c1-7cda-43b5-96c9-80057f0fdce0"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"8db7ce85-25d3-4c7c-97a5-29dba05549b6"},{"name":"home-page-2.html","guid":"ef4193c1-7cda-43b5-96c9-80057f0fdce0"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "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": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"5c552bdf-102a-4909-ba76-dbcfb0a5fc46"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"5c552bdf-102a-4909-ba76-dbcfb0a5fc46"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"5c552bdf-102a-4909-ba76-dbcfb0a5fc46"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get the header information for a Home Page File",
+ "operationId": "GetHomePageFile",
+ "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/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c13eb185-2558-4b4a-8395-33c031663925","description":"Description of home page file.","extension":"html","dataLength":12895,"path":"HomePages","name":"home-page.html","guid":"92e8e3e6-b87a-4f51-896f-7ac3c82db877"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c13eb185-2558-4b4a-8395-33c031663925","description":"Description of home page file.","extension":"html","dataLength":12895,"path":"HomePages","name":"home-page.html","guid":"92e8e3e6-b87a-4f51-896f-7ac3c82db877"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c13eb185-2558-4b4a-8395-33c031663925","description":"Description of home page file.","extension":"html","dataLength":12895,"path":"HomePages","name":"home-page.html","guid":"92e8e3e6-b87a-4f51-896f-7ac3c82db877"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Update an existing Home Page File.",
+ "operationId": "UpdateHomePageFile",
+ "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/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"53731282-6a56-4e2b-95e9-27bdb5b5d966"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"53731282-6a56-4e2b-95e9-27bdb5b5d966"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"53731282-6a56-4e2b-95e9-27bdb5b5d966"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"53731282-6a56-4e2b-95e9-27bdb5b5d966"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"e2877445-5e58-43e5-9a92-daea4746c984"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"e2877445-5e58-43e5-9a92-daea4746c984"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"e2877445-5e58-43e5-9a92-daea4746c984"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:export": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Home Page File as a file",
+ "operationId": "ExportHomePageFile",
+ "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"
+ },
+ "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": "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GrantaServerApiSchemaFilesMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"e2e3cebf-3bb0-4610-b882-66a833b6e522"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"e2e3cebf-3bb0-4610-b882-66a833b6e522"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFileHeader"
+ },
+ "example": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"e2e3cebf-3bb0-4610-b882-66a833b6e522"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections": {
+ "get": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Get all sections for a layout",
+ "operationId": "GetLayoutSections",
+ "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/GrantaServerApiSchemaLayoutsLayoutSectionsInfo"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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":"4d02589c-606c-442b-8fd3-4b6791409ffc","name":"Price","guid":"f1cde3a4-170b-40f9-9c42-e94c30e54aa1"},{"itemType":"attribute","attributeType":"point","required":false,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"1aca89a2-f3e1-40a2-ae98-69967aa9682c","name":"Density","guid":"3e7b8dd5-9c83-41db-bf56-5a88692bc3e2"}],"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":"6e4a08b0-92d8-482b-9a93-a2ca33694bb5","name":"Young's modulus","guid":"79813a30-7f96-427c-8b0e-bb6242e5a38e"},{"itemType":"attribute","attributeType":"range","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"45a1d589-553b-4901-88dc-e963917c64fb","name":"Tensile strength","guid":"3c1aac8a-e355-4462-a59e-6b4a46e639f9"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"ebdc95d9-2585-44d6-b9d2-2ed3355e99ed","name":"Shape factor","guid":"030783d9-034b-4a0f-8d4f-25cb49e2c8d9"}],"displayNames":{"en":"Mechanical Properties English Display Name","fr":"Mechanical Properties French Display Name"},"name":"Mechanical Properties","guid":"aa6a7ef2-0e37-40a6-b3eb-11d502408281"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Create a new layout section.",
+ "operationId": "CreateSection",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"4ba16005-184c-46e7-8938-378fa2887cb1"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"4ba16005-184c-46e7-8938-378fa2887cb1"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"4ba16005-184c-46e7-8938-378fa2887cb1"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"4ba16005-184c-46e7-8938-378fa2887cb1"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayoutSection"
+ },
+ "example": {"sectionDetailType":"slim","displayNames":{},"name":"Additional Properties","guid":"eb41ec04-17d9-4398-adcc-0571536ad46e"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Reorder the list of layout sections for a layout.",
+ "operationId": "ReorderSections",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSectionsInfo"
+ },
+ "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"
+ },
+ "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}": {
+ "get": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Get a layout section with a specified guid for a given layout.",
+ "operationId": "GetLayoutSection",
+ "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"
+ }
+ },
+ {
+ "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/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ "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":"93557317-89bc-4a64-8697-ea6693770a68"}
+ },
+ "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":[{"itemType":"attribute","attributeType":"shortText","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"63f051f7-9f38-41b6-a5c5-5018a05c5e3c","name":"Form","guid":"905caf4f-eb52-4804-a7ad-99f1f3734b15"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[{"itemType":"attribute","attributeType":"longText","required":true,"readOnly":false,"underlyingEntityGuid":"d84141d7-bb0a-4c10-9783-c041047b3de0","name":"Sources","guid":"ea6e2a58-17ff-4471-879c-59932427d14d"},{"itemType":"attribute","attributeType":"shortText","required":true,"readOnly":false,"underlyingEntityGuid":"110ab8b2-7dee-455a-96d1-6aaad812c28d","name":"Notes","guid":"3978573e-3c74-48bc-b31a-98c442216410"}],"underlyingEntityGuid":"4d0483bc-2da5-4577-a850-0d0506f339b1","name":"Chemical resistance","guid":"6072e078-b406-4348-861f-664fe4f4258c"},{"itemType":"link","linkType":"recordLink","targetDatabase":"64ac535c-9032-4036-ae62-81c04e84b6cd","targetDatabaseVersion":"bc95b663-86c4-4a0e-a965-2081ceb34c7e","targetTable":"4b3494fa-86a2-49b0-810a-face197ab01b","forwards":true,"underlyingEntityGuid":"9c0978d2-2b14-4e02-9609-34bfcc6a3d08","name":"Material Pedigree","guid":"b94f23e6-754a-43bd-9e62-4aeb1b212c0d"},{"itemType":"attribute","attributeType":"link","required":false,"readOnly":false,"metaAttributes":[],"tabularColumns":[{"columnType":"linkedAttribute","tabularColumnGuid":"e172cd54-6484-44d0-93dc-9d3a7ffd8577","name":"Offset Yield Stress","guid":"cefe4f28-c7f4-43ad-8025-27331b373f6e"},{"columnType":"localShortText","tabularColumnGuid":"f5250e5b-2991-4979-a67b-549af35a1c15","name":"Young's Modulus Notes","guid":"9d68c176-c330-40da-bdce-3c6beab56a38"}],"underlyingEntityGuid":"c960dbc4-ceed-4d03-915b-3535e02111ba","name":"Reference Characteristics","guid":"22b4b5e3-6e00-43a2-bd48-4d3e89cac617"},{"itemType":"link","linkType":"associationChain","targetDatabase":"64ac535c-9032-4036-ae62-81c04e84b6cd","targetDatabaseVersion":"bc95b663-86c4-4a0e-a965-2081ceb34c7e","targetTable":"99dd7f7c-db5e-4835-b10d-fcf86161b5be","forwards":true,"nextLink":{"itemType":"link","linkType":"associationChain","targetDatabase":"64ac535c-9032-4036-ae62-81c04e84b6cd","targetDatabaseVersion":"bc95b663-86c4-4a0e-a965-2081ceb34c7e","targetTable":"d42dac0e-f9f3-4a94-af5d-9bb83e3485d2","forwards":false,"underlyingEntityGuid":"c34618d2-a8fe-40c6-ad02-ab6952732efa","name":"Pedigree information","guid":"b1695845-d9c1-4a93-8142-fbf1a41cf0bd"},"underlyingEntityGuid":"5e769a17-8052-4ae6-93d8-a40014ecf565","name":"To Pedigree from Producers","guid":"a8a5e6c1-244b-4ec8-a7ac-fe1ef89066db"}],"displayNames":{"de":"Testing Information German Display Name","fr":"Testing Information French Display Name"},"name":"Testing Information","guid":"ef5b5433-ed09-415f-a7cc-26ff73546456"}
+ }
+ }
+ }
+ }
+ },
+ "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, table, layout or layout 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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"a1fd99da-3e36-4328-a4ff-74be2972341b","sourceTableGuid":"65f08db2-1945-4d96-8598-953710e79a86","linkGroupGuid":"0ce60cd5-af99-4d54-846c-c241e7641727"}
+ },
+ "Example 16": {
+ "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":"d6722f36-1cf3-4eba-83e9-8b0c6bcbfdcd","tabularAttributeGuid":"c8d1be06-b114-4cb1-be6b-c3c28a0bd264"},{"forwards":false,"sourceDatabaseVersionGuid":"9a3ff0ea-ab41-4f0a-b088-24ff1c8c0c9a","tabularAttributeGuid":"b44e95bf-e4f0-4037-8cf0-9153b0caf9a9"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"a1fd99da-3e36-4328-a4ff-74be2972341b","sourceTableGuid":"65f08db2-1945-4d96-8598-953710e79a86","linkGroupGuid":"0ce60cd5-af99-4d54-846c-c241e7641727"}
+ },
+ "Example 16": {
+ "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":"d6722f36-1cf3-4eba-83e9-8b0c6bcbfdcd","tabularAttributeGuid":"c8d1be06-b114-4cb1-be6b-c3c28a0bd264"},{"forwards":false,"sourceDatabaseVersionGuid":"9a3ff0ea-ab41-4f0a-b088-24ff1c8c0c9a","tabularAttributeGuid":"b44e95bf-e4f0-4037-8cf0-9153b0caf9a9"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"a1fd99da-3e36-4328-a4ff-74be2972341b","sourceTableGuid":"65f08db2-1945-4d96-8598-953710e79a86","linkGroupGuid":"0ce60cd5-af99-4d54-846c-c241e7641727"}
+ },
+ "Example 16": {
+ "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":"d6722f36-1cf3-4eba-83e9-8b0c6bcbfdcd","tabularAttributeGuid":"c8d1be06-b114-4cb1-be6b-c3c28a0bd264"},{"forwards":false,"sourceDatabaseVersionGuid":"9a3ff0ea-ab41-4f0a-b088-24ff1c8c0c9a","tabularAttributeGuid":"b44e95bf-e4f0-4037-8cf0-9153b0caf9a9"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"a1fd99da-3e36-4328-a4ff-74be2972341b","sourceTableGuid":"65f08db2-1945-4d96-8598-953710e79a86","linkGroupGuid":"0ce60cd5-af99-4d54-846c-c241e7641727"}
+ },
+ "Example 16": {
+ "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":"d6722f36-1cf3-4eba-83e9-8b0c6bcbfdcd","tabularAttributeGuid":"c8d1be06-b114-4cb1-be6b-c3c28a0bd264"},{"forwards":false,"sourceDatabaseVersionGuid":"9a3ff0ea-ab41-4f0a-b088-24ff1c8c0c9a","tabularAttributeGuid":"b44e95bf-e4f0-4037-8cf0-9153b0caf9a9"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ "examples": {
+ "Example 8": {
+ "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":"2278d1ef-587d-472c-bd62-34b14d0db370"}
+ },
+ "Example 9": {
+ "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":"076128bd-7ef9-4ce2-8b8e-e2c835dfcf84"}
+ },
+ "Example 10": {
+ "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 11": {
+ "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","linkGroupGuid":"00e07ec0-695e-4ca3-bf1d-3bbeef126949","guid":null}
+ },
+ "Example 12": {
+ "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 13": {
+ "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":"48132e88-b263-41cd-8539-8f4eececb2a0","sourceTableGuid":"154f8025-de88-476c-b974-00c558456939","linkGroupGuid":"9a47366a-10b3-43ad-af8d-f35f00a7ba1b","guid":null}
+ },
+ "Example 14": {
+ "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":"4f9301da-0d06-4e2c-8e27-cfdcb08242a7"},{"forwards":false,"sourceDatabaseVersionGuid":"00000000-0000-0000-0000-000000000000","tabularAttributeGuid":"2382f09b-1330-4117-9d08-77ac31505fd1"}],"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",
+ "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"
+ }
+ },
+ {
+ "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}/layouts": {
+ "get": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Get all layouts for table",
+ "operationId": "GetLayouts",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutsInfo"
+ },
+ "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 table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Create a new layout.",
+ "operationId": "CreateLayout",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"72771499-4013-46d2-83dd-e12f67d644cd"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"72771499-4013-46d2-83dd-e12f67d644cd"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"72771499-4013-46d2-83dd-e12f67d644cd"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsCreateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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"}
+ },
+ "Example 4": {
+ "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":"Composite materials (guid)","guid":"72771499-4013-46d2-83dd-e12f67d644cd"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "example": {"displayNames":{},"name":"Ceramics","guid":"916c04fa-6804-40dc-8891-e71bec6feb6f"}
+ }
+ }
+ },
+ "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",
+ "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/GrantaServerApiSchemaLayoutsLayout"
+ },
+ "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"}],"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":"8a2807f6-1801-417b-9392-bbdddfec908f","name":"Price","guid":"71f32c75-5832-4658-aa06-b82bcad83c00"},{"itemType":"attribute","attributeType":"point","required":false,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"516d74a9-6d05-4525-bf89-37731f66d32d","name":"Density","guid":"d982321d-fd38-46b1-add2-d080375496cd"}],"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":"b33deb27-82ed-42da-a335-319c4717bf71","name":"Young's modulus","guid":"976f6ff6-63dd-4f76-a84c-a6aee57d3acf"},{"itemType":"attribute","attributeType":"range","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"33153272-9f4e-4f43-90e8-8a03e49a0ced","name":"Tensile strength","guid":"f9a30f8b-7ff5-4f05-ac47-cfa46d5ed472"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"dbe7e863-903d-4058-8366-cf45a0e979c5","name":"Shape factor","guid":"9c909f06-b594-44e5-8fba-ed7bf3516e09"}],"displayNames":{"en":"Mechanical Properties English Display Name","fr":"Mechanical Properties French Display Name"},"name":"Mechanical Properties","guid":"aa6a7ef2-0e37-40a6-b3eb-11d502408281"}],"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"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Update a layout.",
+ "operationId": "UpdateLayout",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"c0c4421b-b330-4417-b5d0-ad4a85c8a435"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"c0c4421b-b330-4417-b5d0-ad4a85c8a435"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"c0c4421b-b330-4417-b5d0-ad4a85c8a435"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsUpdateLayout"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"name":"Ceramics (Updated)","guid":"c0c4421b-b330-4417-b5d0-ad4a85c8a435"}
+ },
+ "Example 4": {
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayout"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Delete a layout.",
+ "operationId": "DeleteLayout",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout 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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParametersInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Create a new parameter.",
+ "operationId": "CreateParameter",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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":"9476cdef-8b44-4dbf-aac3-6ddd69d3662a"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"65b3a2aa-3b49-43e1-9a7d-4988de159815"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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":"9476cdef-8b44-4dbf-aac3-6ddd69d3662a"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"65b3a2aa-3b49-43e1-9a7d-4988de159815"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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":"9476cdef-8b44-4dbf-aac3-6ddd69d3662a"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"65b3a2aa-3b49-43e1-9a7d-4988de159815"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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":"9476cdef-8b44-4dbf-aac3-6ddd69d3662a"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"65b3a2aa-3b49-43e1-9a7d-4988de159815"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "example": {"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"
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "example": {"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"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or parameter not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Update a parameter.",
+ "operationId": "UpdateParameter",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"f001c57b-8a4e-4aa8-b96f-cd36eb1d5f24"}
+ },
+ "Example 9": {
+ "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":"16796d4f-91c8-4b6b-b9b7-6941741f9066"}
+ },
+ "Example 10": {
+ "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":"95ca0b0e-a16e-459b-bb42-0e6ff569a015"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"35139795-22ac-4b1c-bf06-05bfa4d7fa0d"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"f001c57b-8a4e-4aa8-b96f-cd36eb1d5f24"}
+ },
+ "Example 9": {
+ "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":"16796d4f-91c8-4b6b-b9b7-6941741f9066"}
+ },
+ "Example 10": {
+ "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":"95ca0b0e-a16e-459b-bb42-0e6ff569a015"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"35139795-22ac-4b1c-bf06-05bfa4d7fa0d"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"f001c57b-8a4e-4aa8-b96f-cd36eb1d5f24"}
+ },
+ "Example 9": {
+ "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":"16796d4f-91c8-4b6b-b9b7-6941741f9066"}
+ },
+ "Example 10": {
+ "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":"95ca0b0e-a16e-459b-bb42-0e6ff569a015"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"35139795-22ac-4b1c-bf06-05bfa4d7fa0d"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"f001c57b-8a4e-4aa8-b96f-cd36eb1d5f24"}
+ },
+ "Example 9": {
+ "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":"16796d4f-91c8-4b6b-b9b7-6941741f9066"}
+ },
+ "Example 10": {
+ "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":"95ca0b0e-a16e-459b-bb42-0e6ff569a015"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"35139795-22ac-4b1c-bf06-05bfa4d7fa0d"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "example": {"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"
+ },
+ "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": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDeletionParameterDeletionException"
+ },
+ "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":"inUse","referencedByType":"attribute","referencedBy":[{"name":"Stress","guid":"af033295-75d5-4f92-96cf-280c0142bf1e"}]}]}
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimObjects"
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/GrantaServerApiSchemaParametersParameterValue"
+ },
+ "example": {"type":"numeric","value":0.1,"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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"08705922-b357-4633-968c-f495b5ad3088"}
+ },
+ "Example 5": {
+ "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":"e231df58-0deb-410c-9c8f-aad0313856e7"}
+ },
+ "Example 6": {
+ "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":"ec1fe0e9-dfcf-4f0e-a11e-cafa212929f8"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"08705922-b357-4633-968c-f495b5ad3088"}
+ },
+ "Example 5": {
+ "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":"e231df58-0deb-410c-9c8f-aad0313856e7"}
+ },
+ "Example 6": {
+ "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":"ec1fe0e9-dfcf-4f0e-a11e-cafa212929f8"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"08705922-b357-4633-968c-f495b5ad3088"}
+ },
+ "Example 5": {
+ "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":"e231df58-0deb-410c-9c8f-aad0313856e7"}
+ },
+ "Example 6": {
+ "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":"ec1fe0e9-dfcf-4f0e-a11e-cafa212929f8"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"08705922-b357-4633-968c-f495b5ad3088"}
+ },
+ "Example 5": {
+ "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":"e231df58-0deb-410c-9c8f-aad0313856e7"}
+ },
+ "Example 6": {
+ "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":"ec1fe0e9-dfcf-4f0e-a11e-cafa212929f8"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterValue"
+ },
+ "example": {"type":"numeric","value":0.1,"guid":"173284fb-e557-406f-a7eb-f4e75f1d48a9"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Parameter in use."
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/GrantaServerApiExceptionsDeletionParameterValueDeletionException"
+ },
+ "example": {"message":"Cannot delete parameter value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1').","code":400,"errors":[{"message":"It is being used in one or more parameters as a default value.","reason":"inUse","referencedByType":"defaultParameterValue","referencedBy":[{"name":"Basis","guid":"7a6ccb7b-8a47-4cab-8203-c741d476560f"}]}]}
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "parameter-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaParametersParameterValue"
+ },
+ "example": {"type":"numeric","value":0.1,"guid":"173284fb-e557-406f-a7eb-f4e75f1d48a9"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Parameter in use."
+ },
+ "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/GrantaServerApiSchemaProfilesAllProfilesInfo"
+ },
+ "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"},{"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/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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"}}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaProfilesUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesAllProfilesInfo"
+ },
+ "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"},{"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"
+ },
+ "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/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"46339ebd-097d-40c5-8583-c9c85ee5ab11"}
+ },
+ "Example 6": {
+ "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":"cee7857b-073b-4076-803a-f6fcde0fe4fb"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"46339ebd-097d-40c5-8583-c9c85ee5ab11"}
+ },
+ "Example 6": {
+ "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":"cee7857b-073b-4076-803a-f6fcde0fe4fb"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"46339ebd-097d-40c5-8583-c9c85ee5ab11"}
+ },
+ "Example 6": {
+ "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":"cee7857b-073b-4076-803a-f6fcde0fe4fb"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"46339ebd-097d-40c5-8583-c9c85ee5ab11"}
+ },
+ "Example 6": {
+ "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":"cee7857b-073b-4076-803a-f6fcde0fe4fb"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesProfile"
+ },
+ "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"}
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaProfilesProfile"
+ },
+ "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/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"39b15b4e-cf74-4357-80bd-da4e08beeb5d"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"628d4e8a-c650-49a5-88ed-e2e516bb906a","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"39b15b4e-cf74-4357-80bd-da4e08beeb5d"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"628d4e8a-c650-49a5-88ed-e2e516bb906a","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"39b15b4e-cf74-4357-80bd-da4e08beeb5d"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"628d4e8a-c650-49a5-88ed-e2e516bb906a","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"39b15b4e-cf74-4357-80bd-da4e08beeb5d"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"628d4e8a-c650-49a5-88ed-e2e516bb906a","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesProfile"
+ },
+ "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"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Profile not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Profiles"
+ ],
+ "summary": "Delete a profile",
+ "operationId": "DeleteProfile",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "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,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesProfileTablesInfo"
+ },
+ "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": "Profile not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - ProfileTables"
+ ],
+ "summary": "Create a new profile table",
+ "operationId": "CreateProfileTable",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"1ed97bb1-05fb-4afa-9e2f-6bc984d1166e"}
+ },
+ "Example 6": {
+ "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": {"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":"5342d5b5-d1ac-4f64-b234-cbd3e026180c"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"1ed97bb1-05fb-4afa-9e2f-6bc984d1166e"}
+ },
+ "Example 6": {
+ "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": {"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":"5342d5b5-d1ac-4f64-b234-cbd3e026180c"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"1ed97bb1-05fb-4afa-9e2f-6bc984d1166e"}
+ },
+ "Example 6": {
+ "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": {"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":"5342d5b5-d1ac-4f64-b234-cbd3e026180c"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"1ed97bb1-05fb-4afa-9e2f-6bc984d1166e"}
+ },
+ "Example 6": {
+ "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": {"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":"5342d5b5-d1ac-4f64-b234-cbd3e026180c"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesProfileTable"
+ },
+ "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/GrantaServerApiSchemaProfileTablesProfileTable"
+ },
+ "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/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"7b6cf549-ed78-4125-aeb5-19094f05fb50"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"22f08a0c-bfec-41f8-8586-30fa4c6e1525"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"7b6cf549-ed78-4125-aeb5-19094f05fb50"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"22f08a0c-bfec-41f8-8586-30fa4c6e1525"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"7b6cf549-ed78-4125-aeb5-19094f05fb50"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"22f08a0c-bfec-41f8-8586-30fa4c6e1525"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"7b6cf549-ed78-4125-aeb5-19094f05fb50"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"22f08a0c-bfec-41f8-8586-30fa4c6e1525"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfileTablesProfileTable"
+ },
+ "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}/tables/{table-guid}/record-link-groups": {
+ "get": {
+ "tags": [
+ "Schema - Record Link Groups"
+ ],
+ "summary": "Get all record link groups",
+ "operationId": "GetRecordLinkGroups",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupsInfo"
+ },
+ "example": {"recordLinkGroups":[{"identity":115,"type":"static","reverseName":"Training Exercise","reverseDisplayNames":{},"displayNames":{},"name":"MaterialUniverse","guid":"00e07ec0-695e-4ca3-bf1d-3bbeef126949"},{"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"},"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":"35f15fc5-c6d4-4400-9ac4-5b9bc3c7c186"}]}
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"1d4c8653-9b9a-47bb-b3a6-0ff4da546db4"}
+ },
+ "Example 9": {
+ "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":"31e53554-abbe-478a-addf-3473fed712f5"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"a7cda6a5-ac55-4947-ba62-dca081225d76","tableGuid":"d8f711cb-a8ba-4aa7-981a-43d8a1ae7565"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"bb8e6d13-19fe-4f29-a137-ebc95f657277"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"6e7d799e-f07e-43fb-91f7-ce168d91e82f"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"1d4c8653-9b9a-47bb-b3a6-0ff4da546db4"}
+ },
+ "Example 9": {
+ "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":"31e53554-abbe-478a-addf-3473fed712f5"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"a7cda6a5-ac55-4947-ba62-dca081225d76","tableGuid":"d8f711cb-a8ba-4aa7-981a-43d8a1ae7565"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"bb8e6d13-19fe-4f29-a137-ebc95f657277"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"6e7d799e-f07e-43fb-91f7-ce168d91e82f"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"1d4c8653-9b9a-47bb-b3a6-0ff4da546db4"}
+ },
+ "Example 9": {
+ "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":"31e53554-abbe-478a-addf-3473fed712f5"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"a7cda6a5-ac55-4947-ba62-dca081225d76","tableGuid":"d8f711cb-a8ba-4aa7-981a-43d8a1ae7565"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"bb8e6d13-19fe-4f29-a137-ebc95f657277"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"6e7d799e-f07e-43fb-91f7-ce168d91e82f"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"1d4c8653-9b9a-47bb-b3a6-0ff4da546db4"}
+ },
+ "Example 9": {
+ "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":"31e53554-abbe-478a-addf-3473fed712f5"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"a7cda6a5-ac55-4947-ba62-dca081225d76","tableGuid":"d8f711cb-a8ba-4aa7-981a-43d8a1ae7565"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"bb8e6d13-19fe-4f29-a137-ebc95f657277"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"6e7d799e-f07e-43fb-91f7-ce168d91e82f"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ "examples": {
+ "Example 13": {
+ "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"}},"identity":125,"reverseName":"Fatigue Statistical Data","reverseDisplayNames":{},"displayNames":{},"name":"Fatigue Test Data","guid":"485da78d-d094-4edb-a5a9-077fe1bc02f2"}
+ },
+ "Example 14": {
+ "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"},"linkTarget":{"databaseGuid":"895d5335-31d2-45a6-9217-52be7ecb772d","tableGuid":"7812582a-b4ea-44d2-8fd7-148039503e0f"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"02aae21b-d45d-4665-ae12-f81f13bd900a"}
+ },
+ "Example 15": {
+ "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":[{"attributeSource":{"type":"shortText","displayNames":{},"name":"Panel Number","guid":"6e50a7a8-a759-44c9-b151-215a07949c1f"},"attributeTarget":{"type":"shortText","displayNames":{},"name":"Panel Number","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"},"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 or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups:inbound-link-groups": {
+ "get": {
+ "tags": [
+ "Schema - Record Link Groups"
+ ],
+ "summary": "Get all record link groups pointing towards provided table",
+ "operationId": "GetInboundRecordLinkGroups",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupsInfo"
+ },
+ "example": {"recordLinkGroups":[{"identity":115,"type":"static","reverseName":"Training Exercise","reverseDisplayNames":{},"displayNames":{},"name":"MaterialUniverse","guid":"00e07ec0-695e-4ca3-bf1d-3bbeef126949"},{"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"},"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":"MI Training MaterialUniverse - Second Training Database And Table","reverseDisplayNames":{},"displayNames":{},"name":"Second Training Database And Table - MI Training MaterialUniverse","guid":"6cb3ca3e-3af5-435c-9dc2-4a3503cea623"}]}
+ }
+ }
+ },
+ "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",
+ "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": "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/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ "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"}},"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"},"linkTarget":{"databaseGuid":"adee8d30-ce98-48a5-a538-e1c0850ebe3c","tableGuid":"fca33740-a2bb-46eb-b4f5-9c20421042b0"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"a0bc88a0-96c3-41f9-9752-0b4a3afee7a0"}
+ },
+ "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": {"type":"dynamic","forbidOrphans":false,"referentialIntegrityModel":"oneToMany","attributePairs":[{"attributeSource":{"type":"shortText","displayNames":{},"name":"Panel Number","guid":"6e50a7a8-a759-44c9-b151-215a07949c1f"},"attributeTarget":{"type":"shortText","displayNames":{},"name":"Panel Number","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"},"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",
+ "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"
+ }
+ }
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"b16b0d4d-9d57-4f45-96d8-1249dafd13ed"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"7d52fd9c-b677-48d4-b232-fd6fe7a29a9f"}
+ },
+ "Example 9": {
+ "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":"6bd06e9a-0ac5-4f14-a71d-4dff289a6234"}
+ },
+ "Example 10": {
+ "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":"5e9e8882-b99f-46bd-b1a5-1d7f1f42e84c"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"b16b0d4d-9d57-4f45-96d8-1249dafd13ed"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"7d52fd9c-b677-48d4-b232-fd6fe7a29a9f"}
+ },
+ "Example 9": {
+ "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":"6bd06e9a-0ac5-4f14-a71d-4dff289a6234"}
+ },
+ "Example 10": {
+ "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":"5e9e8882-b99f-46bd-b1a5-1d7f1f42e84c"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"b16b0d4d-9d57-4f45-96d8-1249dafd13ed"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"7d52fd9c-b677-48d4-b232-fd6fe7a29a9f"}
+ },
+ "Example 9": {
+ "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":"6bd06e9a-0ac5-4f14-a71d-4dff289a6234"}
+ },
+ "Example 10": {
+ "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":"5e9e8882-b99f-46bd-b1a5-1d7f1f42e84c"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"b16b0d4d-9d57-4f45-96d8-1249dafd13ed"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"7d52fd9c-b677-48d4-b232-fd6fe7a29a9f"}
+ },
+ "Example 9": {
+ "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":"6bd06e9a-0ac5-4f14-a71d-4dff289a6234"}
+ },
+ "Example 10": {
+ "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":"5e9e8882-b99f-46bd-b1a5-1d7f1f42e84c"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ "examples": {
+ "Example 16": {
+ "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"}},"identity":125,"reverseName":"Fatigue Statistical Data","reverseDisplayNames":{},"displayNames":{},"name":"Fatigue Test Data","guid":"485da78d-d094-4edb-a5a9-077fe1bc02f2"}
+ },
+ "Example 17": {
+ "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"},"linkTarget":{"databaseGuid":"53c8cec2-d1c2-4006-9155-e463f20d62a5","tableGuid":"401f3960-7e2c-481a-af5f-b40b300d8eec"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"13c9e94a-f33c-444a-bbd6-f843b1ff4a43"}
+ },
+ "Example 18": {
+ "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":[{"attributeSource":{"type":"shortText","displayNames":{},"name":"Panel Number","guid":"6e50a7a8-a759-44c9-b151-215a07949c1f"},"attributeTarget":{"type":"shortText","displayNames":{},"name":"Panel Number","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"},"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 record link group 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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardNamesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Create a new standard name",
+ "operationId": "CreateStandardName",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"f9166b4f-337e-401e-9119-9b7f9aa3e2bb"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"f9166b4f-337e-401e-9119-9b7f9aa3e2bb"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"f9166b4f-337e-401e-9119-9b7f9aa3e2bb"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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/GrantaServerApiSchemaStandardNamesCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"f9166b4f-337e-401e-9119-9b7f9aa3e2bb"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardName"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "standard-name-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardName"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or standard name not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Edit a standard name",
+ "operationId": "UpdateStandardName",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "standard-name-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"ab2750de-9e4e-4b6f-b21c-68a474c6e01c"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"ab2750de-9e4e-4b6f-b21c-68a474c6e01c"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"ab2750de-9e4e-4b6f-b21c-68a474c6e01c"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"ab2750de-9e4e-4b6f-b21c-68a474c6e01c"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaStandardNamesStandardName"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": "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": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsSubsetsInfo"
+ },
+ "example": {"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 or table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Subsets"
+ ],
+ "summary": "Create a new subset.",
+ "operationId": "CreateSubset",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"385ed593-5451-435d-a741-7932d61ca619"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"385ed593-5451-435d-a741-7932d61ca619"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"385ed593-5451-435d-a741-7932d61ca619"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"385ed593-5451-435d-a741-7932d61ca619"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsSubset"
+ },
+ "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",
+ "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",
+ "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/GrantaServerApiSchemaSubsetsSubset"
+ },
+ "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",
+ "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",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"db595025-bc8f-4951-87bb-0ad268adba56"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"db595025-bc8f-4951-87bb-0ad268adba56"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"db595025-bc8f-4951-87bb-0ad268adba56"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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/GrantaServerApiSchemaSubsetsUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"db595025-bc8f-4951-87bb-0ad268adba56"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsSubset"
+ },
+ "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"}
+ }
+ }
+ },
+ "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",
+ "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",
+ "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",
+ "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",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsAddRecordHistoryToSubset"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaSubsetsAddRecordHistoryToSubset"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaSubsetsAddRecordHistoryToSubset"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GrantaServerApiSchemaSubsetsAddRecordHistoryToSubset"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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, 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",
+ "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",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"recordHistoryGuid":"5a842e54-e143-45f5-aec8-18fb84f4fe03"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"recordHistoryGuid":"5a842e54-e143-45f5-aec8-18fb84f4fe03"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"recordHistoryGuid":"5a842e54-e143-45f5-aec8-18fb84f4fe03"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSubsetsRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTablesInfo"
+ },
+ "example": {"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 not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Create a new table.",
+ "operationId": "CreateTable",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"464affd6-98ca-4017-a626-62de3f0fdb34"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"464affd6-98ca-4017-a626-62de3f0fdb34"}
+ },
+ "Example 6": {
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"464affd6-98ca-4017-a626-62de3f0fdb34"}
+ },
+ "Example 6": {
+ "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/GrantaServerApiSchemaTablesCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"464affd6-98ca-4017-a626-62de3f0fdb34"}
+ },
+ "Example 6": {
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "example": {"versionState":"unversioned","isHiddenFromBrowse":false,"isHiddenFromSearch":false,"isVersioned":false,"tableTypes":[],"displayNames":{},"name":"Material Universe","guid":"0000dd92-0011-4fff-8fff-0000ffff0000"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "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","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 table not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Update a table.",
+ "operationId": "UpdateTable",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"f8901583-a32a-4730-81a5-634caddddaee"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"f8901583-a32a-4730-81a5-634caddddaee"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"f8901583-a32a-4730-81a5-634caddddaee"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GrantaServerApiSchemaTablesUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"f8901583-a32a-4730-81a5-634caddddaee"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "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","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 table not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Delete a table.",
+ "operationId": "DeleteTable",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request. Table in use.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDeletionTableDeletionException"
+ },
+ "example": {"message":"Cannot delete table 'Restricted Substances' (GUID = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f').","code":400,"errors":[{"message":"It is being used in one or more tabular attributes.","reason":"inUse","referencedByType":"tabularAttribute","referencedBy":[{"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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "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","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/GrantaServerApiExceptionsVersionControlReleaseTableVersionControlException"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Invalid version state.",
+ "description": "A table can only be released if it is currently unreleased.",
+ "value": {"message":"Cannot release table 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'.","code":400,"errors":[{"message":"Invalid version state 'Released'.","reason":"invalidVersionState","versionState":"released"}]}
+ },
+ "Example 4": {
+ "summary": "Table is not version controlled.",
+ "value": {"message":"Cannot release table '0000dd92-0011-4fff-8fff-0000ffff0000'.","code":400,"errors":[{"message":"Table is not version controlled.","reason":"notVersioned"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTablesTable"
+ },
+ "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","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}/units/{unit-guid}/equivalent-units": {
+ "get": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Get equivalent units (one per unit system)",
+ "operationId": "GetUnitEquivalents",
+ "parameters": [
+ {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitEquivalentsInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ }
+ },
+ "/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 - Units"
+ ],
+ "summary": "Set the equivalent unit for a given unit system",
+ "operationId": "SetUnitEquivalent",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "unit-system-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "equivalent-unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "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/GrantaServerApiSchemaUnitsUnitsInfo"
+ }
+ }
+ }
+ },
+ "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/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnit"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Update unit.",
+ "operationId": "UpdateUnit",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnit"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ }
+ }
+ },
+ "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": "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": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitsInfo"
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitUsage"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit 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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystemsInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Create a new unit system.",
+ "operationId": "CreateUnitSystem",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"64edcef1-471a-4674-935d-68b89e5a8749"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"64edcef1-471a-4674-935d-68b89e5a8749"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"64edcef1-471a-4674-935d-68b89e5a8749"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"64edcef1-471a-4674-935d-68b89e5a8749"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-system-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ }
+ }
+ }
+ },
+ "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": "unit-system-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"ae6d644d-c5e2-4030-a138-045db94c5d8b"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"185ea859-3016-4735-ac5c-75bdd38a14cb"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"ae6d644d-c5e2-4030-a138-045db94c5d8b"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"185ea859-3016-4735-ac5c-75bdd38a14cb"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"ae6d644d-c5e2-4030-a138-045db94c5d8b"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"185ea859-3016-4735-ac5c-75bdd38a14cb"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"ae6d644d-c5e2-4030-a138-045db94c5d8b"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"185ea859-3016-4735-ac5c-75bdd38a14cb"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/{database-key}/tables/{table-identity}:search": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "operationId": "DatabaseSearchInTableWithIdentity",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "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/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["73b3ed5d-7609-484a-9ee1-baa8de3f61df","f5e59ba0-0b63-4cef-8669-5bf07bed97b5"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["73b3ed5d-7609-484a-9ee1-baa8de3f61df","f5e59ba0-0b63-4cef-8669-5bf07bed97b5"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["73b3ed5d-7609-484a-9ee1-baa8de3f61df","f5e59ba0-0b63-4cef-8669-5bf07bed97b5"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["73b3ed5d-7609-484a-9ee1-baa8de3f61df","f5e59ba0-0b63-4cef-8669-5bf07bed97b5"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}:search": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "operationId": "DatabaseSearchInTableWithGuid",
+ "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/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["9972ef37-12ea-4453-83e3-719262c12bb9","3c0280d2-442c-45b9-be58-a72ba164388f"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["9972ef37-12ea-4453-83e3-719262c12bb9","3c0280d2-442c-45b9-be58-a72ba164388f"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["9972ef37-12ea-4453-83e3-719262c12bb9","3c0280d2-442c-45b9-be58-a72ba164388f"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["9972ef37-12ea-4453-83e3-719262c12bb9","3c0280d2-442c-45b9-be58-a72ba164388f"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:search": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "operationId": "DatabaseSearch",
+ "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/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["29156177-64fa-480f-b0e7-835c63a59de9","03e1ad08-a251-4841-bae2-9f53d10ef9ba"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["29156177-64fa-480f-b0e7-835c63a59de9","03e1ad08-a251-4841-bae2-9f53d10ef9ba"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["29156177-64fa-480f-b0e7-835c63a59de9","03e1ad08-a251-4841-bae2-9f53d10ef9ba"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 55": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 56": {
+ "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":[]}
+ },
+ "Example 57": {
+ "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 58": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 59": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 60": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 61": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 62": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 63": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 64": {
+ "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":["29156177-64fa-480f-b0e7-835c63a59de9","03e1ad08-a251-4841-bae2-9f53d10ef9ba"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 65": {
+ "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 66": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 67": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 68": {
+ "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":[]}
+ },
+ "Example 69": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 70": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 72": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 75": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 76": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 77": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 78": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 79": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 80": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 81": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["3c90fc0e-f4d7-4a46-9718-14270d5ba4aa","7fd2e299-be92-4582-9b74-f4853951d846"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["3c90fc0e-f4d7-4a46-9718-14270d5ba4aa","7fd2e299-be92-4582-9b74-f4853951d846"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["3c90fc0e-f4d7-4a46-9718-14270d5ba4aa","7fd2e299-be92-4582-9b74-f4853951d846"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchRequest"
+ },
+ "examples": {
+ "Example 82": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 83": {
+ "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":[]}
+ },
+ "Example 84": {
+ "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 85": {
+ "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"},"attributeCriterionType":"matches","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"identity":8965,"attributeType":"integer","type":"attribute","sortDirection":"ascending"}]}
+ },
+ "Example 86": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 87": {
+ "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"},"attributeCriterionType":"exists","identity":5886,"isMetaAttribute":true,"type":"attribute"},{"innerCriterion":{"gte":"1990-01-01T00:00:00+00:00","lte":"1999-12-31T00:00:00+00:00","type":"dateTime"},"attributeCriterionType":"matches","identity":5872,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"all":[],"any":[1665,1666],"none":[],"type":"discreteIdentityValues"},"attributeCriterionType":"matches","identity":5876,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 88": {
+ "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"},"attributeCriterionType":"exists","identity":8965,"isMetaAttribute":false,"type":"attribute"},{"attributeCriterionType":"notApplicable","identity":928,"isMetaAttribute":false,"type":"attribute"}],"any":[],"none":[],"type":"boolean"}],"none":[],"type":"boolean"},"sortCriteria":[]}
+ },
+ "Example 89": {
+ "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"},"attributeCriterionType":"matches","identity":-4,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-9,"isMetaAttribute":false,"type":"attribute"},{"innerCriterion":{"value":"steel","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","identity":-10,"isMetaAttribute":false,"type":"attribute"}],"none":[],"type":"boolean"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 90": {
+ "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"},"attributeCriterionType":"matches","identity":-6,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"property":"recordName","sortType":"natural","type":"recordProperty","sortDirection":"descending"}]}
+ },
+ "Example 91": {
+ "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":["3c90fc0e-f4d7-4a46-9718-14270d5ba4aa","7fd2e299-be92-4582-9b74-f4853951d846"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 92": {
+ "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 93": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 94": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 95": {
+ "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":[]}
+ },
+ "Example 96": {
+ "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"},"attributeCriterionType":"exists","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 97": {
+ "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"},"localColumnCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","type":"localColumn"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 98": {
+ "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"},"attributeCriterionType":"matches","guid":"1f1e5808-5a10-4b70-9ff6-8b832bf561d8","isMetaAttribute":false,"type":"attribute"},"linkDatumType":"tabularAttribute","indirectLinks":"fromLinkDefinition","searchInReversedDirection":false,"targetAttributeGuid":"446d4fc3-f902-4875-9e48-6df9a691c2b0","innerCriterion":{"innerCriterion":{"value":"Alkanes","textMatchBehavior":"contains","type":"shortText"},"attributeCriterionType":"matches","guid":"5555b6f5-d492-4efd-bfe3-3e9faf79ab07","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 99": {
+ "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"},"attributeCriterionType":"matches","guid":"5d7b7b7e-b666-4279-9964-2f28c4123c45","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc","isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"6e5d7d7b-be80-4e81-b013-0a19db19305f","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 101": {
+ "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"},"attributeCriterionType":"exists","identity":8563,"isMetaAttribute":false,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "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"},"attributeCriterionType":"exists","identity":101,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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"},"attributeCriterionType":"exists","identity":33,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":45,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 104": {
+ "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"},"attributeCriterionType":"exists","identity":87,"isMetaAttribute":true,"type":"attribute"},"type":"link","localRowsBehavior":"AllRows"},"attributeCriterionType":"matches","identity":65,"isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 105": {
+ "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":[{"type":"relevance","sortDirection":"ascending"}],"pagingOptions":{"pageSize":5,"keepAliveInMinutes":10,"pageNumber":1}}
+ },
+ "Example 106": {
+ "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":{"type":"floatFunctionalGraph","xAxisParameterGuid":"00000001-000a-4fff-8fff-0000ffff0000","numberOfSeriesGte":1,"showAsTable":false},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[{"type":"relevance","sortDirection":"ascending"}]}
+ },
+ "Example 107": {
+ "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":{"type":"floatFunctionalData","gte":75.0,"lte":80.0,"constraints":[{"gte":100.0,"lte":100.0,"scaleType":"linear","interpolationType":"linear","type":"numeric","parameter":{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}}]},"attributeCriterionType":"matches","guid":"00000001-0001-4fff-8fff-dd92ffff0000","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ },
+ "Example 108": {
+ "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"],"type":"discreteFunctionalValues","constraints":[{"any":["Fresh water"],"type":"discreteName","parameter":{"guid":"b7cee874-160f-439a-a784-b887c516b2d5"}}]},"attributeCriterionType":"matches","guid":"0cb16afc-c567-4e20-943c-9639b30fee62","isMetaAttribute":false,"type":"attribute"},"sortCriteria":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/searches/{searchIdentifier}/results": {
+ "post": {
+ "tags": [
+ "Search"
+ ],
+ "operationId": "GetSearchResults",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResultsRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Search not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/searches/{searchIdentifier}": {
+ "delete": {
+ "tags": [
+ "Search"
+ ],
+ "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/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/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Creates a new search with the specified properties.",
+ "operationId": "CreateSearch",
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesCreateSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/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/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesFindSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/selection-searches/search/{searchIdentifier}": {
+ "get": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Returns the given search if it exists and the calling user has access to it",
+ "operationId": "GetSearch",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSelectionSearch"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Search result not found"
+ },
+ "410": {
+ "description": "Search result no longer available"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSaveSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Search not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Delete an existing selection search.",
+ "operationId": "DeleteSearch",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Selection search not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/status": {
+ "get": {
+ "tags": [
+ "Status"
+ ],
+ "summary": "Check whether the API is available",
+ "operationId": "Get",
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ }
+ },
+ "/v1alpha/status/databases": {
+ "get": {
+ "tags": [
+ "Status"
+ ],
+ "operationId": "GetStatus",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatusInformation"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatusInformation"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatusInformation"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/status/databases/{database-key}": {
+ "get": {
+ "tags": [
+ "Status"
+ ],
+ "operationId": "GetDatabaseStatus",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatusInformation"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatusInformation"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatusInformation"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "GrantaServerApiAdminMiVersion": {
+ "type": "object",
+ "properties": {
+ "binaryCompatibilityVersion": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ },
+ "majorMinorVersion": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsAggregation": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The results of aggregation.\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeAggregation\r\n * GrantaServerApiAggregationsFreeTextAggregation",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregation",
+ "text": "#/components/schemas/GrantaServerApiAggregationsFreeTextAggregation"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationCriterion": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeAggregationCriterion\r\n * GrantaServerApiAggregationsFreeTextAggregationCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationCriterion",
+ "text": "#/components/schemas/GrantaServerApiAggregationsFreeTextAggregationCriterion"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationDatum": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsIntegerAggregation\r\n * GrantaServerApiAggregationsPointAggregation\r\n * GrantaServerApiAggregationsRangeAggregation\r\n * GrantaServerApiAggregationsIntegerHistogramAggregation\r\n * GrantaServerApiAggregationsPointHistogramAggregation\r\n * GrantaServerApiAggregationsRangeHistogramAggregation\r\n * GrantaServerApiAggregationsDateTimeAggregation\r\n * GrantaServerApiAggregationsDateTimeHistogramAggregation\r\n * GrantaServerApiAggregationsShortTextAggregation\r\n * GrantaServerApiAggregationsDiscreteTextAggregation\r\n * GrantaServerApiAggregationsLinkAggregation\r\n * GrantaServerApiAggregationsLogicalAggregation\r\n * GrantaServerApiAggregationsFloatFunctionalAggregation",
+ "discriminator": {
+ "propertyName": "datumType",
+ "mapping": {
+ "integer": "#/components/schemas/GrantaServerApiAggregationsIntegerAggregation",
+ "point": "#/components/schemas/GrantaServerApiAggregationsPointAggregation",
+ "range": "#/components/schemas/GrantaServerApiAggregationsRangeAggregation",
+ "integerHistogram": "#/components/schemas/GrantaServerApiAggregationsIntegerHistogramAggregation",
+ "pointHistogram": "#/components/schemas/GrantaServerApiAggregationsPointHistogramAggregation",
+ "rangeHistogram": "#/components/schemas/GrantaServerApiAggregationsRangeHistogramAggregation",
+ "dateTime": "#/components/schemas/GrantaServerApiAggregationsDateTimeAggregation",
+ "dateTimeHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogramAggregation",
+ "shortText": "#/components/schemas/GrantaServerApiAggregationsShortTextAggregation",
+ "discreteText": "#/components/schemas/GrantaServerApiAggregationsDiscreteTextAggregation",
+ "link": "#/components/schemas/GrantaServerApiAggregationsLinkAggregation",
+ "logical": "#/components/schemas/GrantaServerApiAggregationsLogicalAggregation",
+ "floatFunctionalGraph": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalAggregation"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationDatumCriterion": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsDateTimeAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDateTimeHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDateTimeFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsDiscreteTextAggregationDatumCriterion\r\n * GrantaServerApiAggregationsIntegerAggregationDatumCriterion\r\n * GrantaServerApiAggregationsPointAggregationDatumCriterion\r\n * GrantaServerApiAggregationsRangeAggregationDatumCriterion\r\n * GrantaServerApiAggregationsIntegerHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsIntegerFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsPointHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsPointFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsRangeHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsRangeFixedWidthHistogramAggregationDatumCriterion\r\n * GrantaServerApiAggregationsShortTextAggregationDatumCriterion\r\n * GrantaServerApiAggregationsLinkAggregationDatumCriterion\r\n * GrantaServerApiAggregationsLogicalAggregationDatumCriterion\r\n * GrantaServerApiAggregationsFloatFunctionalAggregationDatumCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "dateTime": "#/components/schemas/GrantaServerApiAggregationsDateTimeAggregationDatumCriterion",
+ "dateTimeHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogramAggregationDatumCriterion",
+ "dateTimeFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeFixedWidthHistogramAggregationDatumCriterion",
+ "dateTimeFixedCalendarWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion",
+ "discreteText": "#/components/schemas/GrantaServerApiAggregationsDiscreteTextAggregationDatumCriterion",
+ "integer": "#/components/schemas/GrantaServerApiAggregationsIntegerAggregationDatumCriterion",
+ "point": "#/components/schemas/GrantaServerApiAggregationsPointAggregationDatumCriterion",
+ "range": "#/components/schemas/GrantaServerApiAggregationsRangeAggregationDatumCriterion",
+ "integerHistogram": "#/components/schemas/GrantaServerApiAggregationsIntegerHistogramAggregationDatumCriterion",
+ "integerFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsIntegerFixedWidthHistogramAggregationDatumCriterion",
+ "pointHistogram": "#/components/schemas/GrantaServerApiAggregationsPointHistogramAggregationDatumCriterion",
+ "pointFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsPointFixedWidthHistogramAggregationDatumCriterion",
+ "rangeHistogram": "#/components/schemas/GrantaServerApiAggregationsRangeHistogramAggregationDatumCriterion",
+ "rangeFixedWidthHistogram": "#/components/schemas/GrantaServerApiAggregationsRangeFixedWidthHistogramAggregationDatumCriterion",
+ "shortText": "#/components/schemas/GrantaServerApiAggregationsShortTextAggregationDatumCriterion",
+ "link": "#/components/schemas/GrantaServerApiAggregationsLinkAggregationDatumCriterion",
+ "logical": "#/components/schemas/GrantaServerApiAggregationsLogicalAggregationDatumCriterion",
+ "floatFunctionalGraph": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalAggregationDatumCriterion"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsAggregationDatumExistsCriterion": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ }
+ },
+ "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"
+ },
+ "GrantaServerApiAggregationsAggregationsRequest": {
+ "type": "object",
+ "properties": {
+ "criterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "aggregationCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationCriterion"
+ },
+ "description": "The aggregations you wish to perform.",
+ "nullable": true
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiAggregationsAggregationsResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregation"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsAttributeAggregation": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregation"
+ }
+ ],
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ },
+ "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"
+ }
+ },
+ "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: GrantaServerApiAggregationsAggregation\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeValueAggregation\r\n * GrantaServerApiAggregationsAttributeExistsAggregation",
+ "discriminator": {
+ "propertyName": "attributeAggregationType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsAttributeValueAggregation",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsAttributeExistsAggregation"
+ }
+ },
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiAggregationsAttributeAggregationCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationCriterion"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "isMetaAttribute": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ },
+ "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: GrantaServerApiAggregationsAggregationCriterion\r\n\r\nThis is one of: \r\n * GrantaServerApiAggregationsAttributeAggregationValueCriterion\r\n * GrantaServerApiAggregationsAttributeAggregationExistsCriterion",
+ "discriminator": {
+ "propertyName": "attributeAggregationCriterionType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationValueCriterion",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationExistsCriterion"
+ }
+ },
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiAggregationsAttributeAggregationExistsCriterion": {
+ "required": [
+ "attributeAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationCriterionType": {
+ "type": "string",
+ "default": "exists"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumExistsCriterion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute.\r\n\r\nThis extends: GrantaServerApiAggregationsAttributeAggregationCriterion",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsAttributeAggregationValueCriterion": {
+ "required": [
+ "attributeAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationCriterionType": {
+ "type": "string",
+ "default": "value"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAttributeAggregationCriterion",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsAttributeExistsAggregation": {
+ "required": [
+ "attributeAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationType": {
+ "type": "string",
+ "default": "exists"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAttributeAggregation",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsAttributeValueAggregation": {
+ "required": [
+ "attributeAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAttributeAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeAggregationType": {
+ "type": "string",
+ "default": "value"
+ },
+ "aggregationDatum": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiAggregationsAttributeAggregation",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsCalendarInterval": {
+ "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"
+ },
+ "GrantaServerApiAggregationsDateTimeAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiAggregationsDateTimeAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiAggregationsDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "interval": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsCalendarInterval"
+ },
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTimeFixedCalendarWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTimeFixedCalendarWidthHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "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)",
+ "nullable": true
+ },
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTimeFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTimeFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeHistogram": {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogramBucket"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsDateTimeHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsDateTimeHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "dateTimeHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "dateTimeHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "description": "The maximum number of buckets to return.",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTimeHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "dateTimeHistogram"
+ },
+ "GrantaServerApiAggregationsDateTimeHistogramBucket": {
+ "type": "object",
+ "properties": {
+ "lower": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsDiscreteTextAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "terms": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsTermWithCount"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "discreteText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "discreteText"
+ },
+ "GrantaServerApiAggregationsDiscreteTextAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "discreteText"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "discreteText"
+ },
+ "GrantaServerApiAggregationsFloatFunctionalAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "seriesGraphs": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalSeriesGraphAggregation"
+ },
+ "gridGraphs": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsFloatFunctionalGridGraphAggregation"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "floatFunctionalGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "floatFunctionalGraph"
+ },
+ "GrantaServerApiAggregationsFloatFunctionalAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "numberOfParameterValues": {
+ "type": "integer",
+ "description": "The maximum number of values to return in this aggregation.",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "floatFunctionalGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion for aggregating the graph information within a float functional attribute.\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "floatFunctionalGraph"
+ },
+ "GrantaServerApiAggregationsFloatFunctionalGridGraphAggregation": {
+ "type": "object",
+ "properties": {
+ "defaultXAxisParameterIdentityValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemInt32"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "defaultXAxisParameterGuidValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemGuid"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "showAsTableValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemBoolean"
+ },
+ "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
+ },
+ "GrantaServerApiAggregationsFloatFunctionalSeriesGraphAggregation": {
+ "type": "object",
+ "properties": {
+ "xAxisParameterIdentityValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemInt32"
+ },
+ "nullable": true
+ },
+ "xAxisParameterGuidValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemGuid"
+ },
+ "nullable": true
+ },
+ "showAsTableValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemBoolean"
+ },
+ "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
+ },
+ "GrantaServerApiAggregationsFreeTextAggregation": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "description": "The GUID of the input aggregation criterion.",
+ "format": "uuid"
+ },
+ "terms": {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "The results of aggregation over an attribute.\r\n\r\nThis extends: GrantaServerApiAggregationsAggregation",
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiAggregationsFreeTextAggregationCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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/GrantaServerApiValueSpecifier"
+ },
+ "localColumns": {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationCriterion",
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiAggregationsHistogram": {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogramBucket"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsHistogramBucket": {
+ "type": "object",
+ "properties": {
+ "lower": {
+ "type": "number",
+ "format": "double"
+ },
+ "upper": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAggregationsIntegerAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "integer"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiAggregationsIntegerAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiAggregationsIntegerFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "type": {
+ "type": "string",
+ "default": "integerFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "integerFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsIntegerHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "integerHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "integerHistogram"
+ },
+ "GrantaServerApiAggregationsIntegerHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "integerHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "integerHistogram"
+ },
+ "GrantaServerApiAggregationsLinkAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localAggregations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregation"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "link"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiAggregationsLinkAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "localAggregationCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationCriterion"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregation": {
+ "type": "object",
+ "properties": {
+ "localColumnIdentity": {
+ "type": "integer",
+ "description": "The identity of the local column that was aggregated over.",
+ "format": "int32",
+ "nullable": true
+ },
+ "localColumnGuid": {
+ "type": "string",
+ "description": "The GUID of the local column that was aggregated over.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "description": "The number of records that have a populated (applicable) value for this local column.",
+ "format": "int32"
+ }
+ },
+ "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 * GrantaServerApiAggregationsLocalColumnValueAggregation\r\n * GrantaServerApiAggregationsLocalColumnExistsAggregation",
+ "discriminator": {
+ "propertyName": "localColumnAggregationType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsLocalColumnValueAggregation",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsLocalColumnExistsAggregation"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregationCriterion": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "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 * GrantaServerApiAggregationsLocalColumnAggregationValueCriterion\r\n * GrantaServerApiAggregationsLocalColumnAggregationExistsCriterion",
+ "discriminator": {
+ "propertyName": "localColumnAggregationCriterionType",
+ "mapping": {
+ "value": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationValueCriterion",
+ "exists": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationExistsCriterion"
+ }
+ }
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregationExistsCriterion": {
+ "required": [
+ "localColumnAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localColumnAggregationCriterionType": {
+ "type": "string",
+ "default": "exists"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumExistsCriterion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A criterion for requesting aggregations for a single specific tabular local column.\r\n\r\nThis extends: GrantaServerApiAggregationsLocalColumnAggregationCriterion",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsLocalColumnAggregationValueCriterion": {
+ "required": [
+ "localColumnAggregationCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localColumnAggregationCriterionType": {
+ "type": "string",
+ "default": "value"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsLocalColumnAggregationCriterion",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsLocalColumnExistsAggregation": {
+ "required": [
+ "localColumnAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localColumnAggregationType": {
+ "type": "string",
+ "default": "exists"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsLocalColumnAggregation",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiAggregationsLocalColumnValueAggregation": {
+ "required": [
+ "localColumnAggregationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsLocalColumnAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "aggregationDatum": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ "localColumnAggregationType": {
+ "type": "string",
+ "default": "value"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsLocalColumnAggregation",
+ "x-discriminator-value": "value"
+ },
+ "GrantaServerApiAggregationsLogicalAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsValueWithCountOfSystemBoolean"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiAggregationsLogicalAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiAggregationsPointAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "point"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiAggregationsPointAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiAggregationsPointFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "type": {
+ "type": "string",
+ "default": "pointFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "pointFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsPointHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "pointHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "pointHistogram"
+ },
+ "GrantaServerApiAggregationsPointHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "pointHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "pointHistogram"
+ },
+ "GrantaServerApiAggregationsRangeAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "range"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiAggregationsRangeAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiAggregationsRangeFixedWidthHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "type": {
+ "type": "string",
+ "default": "rangeFixedWidthHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "rangeFixedWidthHistogram"
+ },
+ "GrantaServerApiAggregationsRangeHistogramAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsHistogram"
+ },
+ "datumType": {
+ "type": "string",
+ "default": "rangeHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "rangeHistogram"
+ },
+ "GrantaServerApiAggregationsRangeHistogramAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "rangeHistogram"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "rangeHistogram"
+ },
+ "GrantaServerApiAggregationsShortTextAggregation": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "terms": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsTermWithCount"
+ },
+ "nullable": true
+ },
+ "datumType": {
+ "type": "string",
+ "default": "shortText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiAggregationsAggregationDatum",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiAggregationsShortTextAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiAggregationsAggregationDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "shortText"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiAggregationsAggregationDatumCriterion",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiAggregationsTermWithCount": {
+ "type": "object",
+ "properties": {
+ "term": {
+ "type": "string",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A term from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAggregationsValueWithCountOfSystemBoolean": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAggregationsValueWithCountOfSystemGuid": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAggregationsValueWithCountOfSystemInt32": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GrantaServerApiAllValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filterOn": {
+ "type": "string",
+ "default": "all"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Specifies no filtering.\r\n\r\nThis extends: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "all"
+ },
+ "GrantaServerApiAppNameLicenseCheckoutRequest": {
+ "type": "object",
+ "properties": {
+ "appNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAppNameLicenseCheckoutResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAppNameLicenseCheckoutResult"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAppNameLicenseCheckoutResult": {
+ "type": "object",
+ "properties": {
+ "appName": {
+ "type": "string",
+ "nullable": true
+ },
+ "licenseStateOk": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsCreateJobRequest": {
+ "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
+ },
+ "GrantaServerApiAsyncJobsCurrentUser": {
+ "type": "object",
+ "properties": {
+ "isAdmin": {
+ "type": "boolean"
+ },
+ "username": {
+ "type": "string",
+ "nullable": true
+ },
+ "hasWriteAccess": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsGetJobsResponse": {
+ "type": "object",
+ "properties": {
+ "totalResultCount": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJob"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsJob": {
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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/GrantaServerApiAsyncJobsJobStatus"
+ },
+ "inputFileIds": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsJobStatus": {
+ "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"
+ },
+ "GrantaServerApiAsyncJobsProcessingConfig": {
+ "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
+ },
+ "GrantaServerApiAsyncJobsResubmitJobRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "scheduledExecutionDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAsyncJobsUpdateJobRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "scheduledExecutionDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/GrantaServerApiAsyncJobsJobStatus"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiAttributeType": {
+ "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"
+ },
+ "GrantaServerApiDataApplicableDatum": {
+ "required": [
+ "datumType",
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataDatum"
+ }
+ ],
+ "properties": {
+ "notApplicable": {
+ "type": "string",
+ "default": "applicable"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataIntegerDatum\r\n * GrantaServerApiDataLogicalDatum\r\n * GrantaServerApiDataShortTextDatum\r\n * GrantaServerApiDataLongTextDatum\r\n * GrantaServerApiDataHyperlinkDatum\r\n * GrantaServerApiDataDateTimeDatum\r\n * GrantaServerApiDataDiscreteDatum\r\n * GrantaServerApiDataRangeDatum\r\n * GrantaServerApiDataPointDatum\r\n * GrantaServerApiDataPictureDatum\r\n * GrantaServerApiDataFileDatum",
+ "discriminator": {
+ "propertyName": "datumType",
+ "mapping": {
+ "integer": "#/components/schemas/GrantaServerApiDataIntegerDatum",
+ "logical": "#/components/schemas/GrantaServerApiDataLogicalDatum",
+ "shortText": "#/components/schemas/GrantaServerApiDataShortTextDatum",
+ "longText": "#/components/schemas/GrantaServerApiDataLongTextDatum",
+ "hyperlink": "#/components/schemas/GrantaServerApiDataHyperlinkDatum",
+ "dateTime": "#/components/schemas/GrantaServerApiDataDateTimeDatum",
+ "discrete": "#/components/schemas/GrantaServerApiDataDiscreteDatum",
+ "range": "#/components/schemas/GrantaServerApiDataRangeDatum",
+ "point": "#/components/schemas/GrantaServerApiDataPointDatum",
+ "picture": "#/components/schemas/GrantaServerApiDataPictureDatum",
+ "file": "#/components/schemas/GrantaServerApiDataFileDatum"
+ }
+ },
+ "x-discriminator-value": "applicable"
+ },
+ "GrantaServerApiDataDateTimeDatum": {
+ "required": [
+ "dateTime",
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "dateTime"
+ },
+ "dateTime": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiDataDatum": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataApplicableDatum\r\n * GrantaServerApiDataNotApplicableDatum",
+ "discriminator": {
+ "propertyName": "notApplicable",
+ "mapping": {
+ "applicable": "#/components/schemas/GrantaServerApiDataApplicableDatum",
+ "notApplicable": "#/components/schemas/GrantaServerApiDataNotApplicableDatum"
+ }
+ }
+ },
+ "GrantaServerApiDataDatumType": {
+ "enum": [
+ "integer",
+ "logical",
+ "shortText",
+ "longText",
+ "hyperlink",
+ "dateTime",
+ "discrete",
+ "range",
+ "point",
+ "picture",
+ "file"
+ ],
+ "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
\r\n"
+ },
+ "GrantaServerApiDataDiscreteDatum": {
+ "required": [
+ "datumType",
+ "discreteValues"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiDataDiscreteParameterWithValue": {
+ "required": [
+ "parameter",
+ "parameterValue",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataParameterWithValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "parameterValue": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameterValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataParameterWithValue",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiDataExportAttributeToExport": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportLinkAttributeToExport\r\n * GrantaServerApiDataExportSimpleAttributeToExport",
+ "discriminator": {
+ "propertyName": "attributeType",
+ "mapping": {
+ "link": "#/components/schemas/GrantaServerApiDataExportLinkAttributeToExport",
+ "simple": "#/components/schemas/GrantaServerApiDataExportSimpleAttributeToExport"
+ }
+ }
+ },
+ "GrantaServerApiDataExportDataExportRequest": {
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ "nullable": true
+ },
+ "recordProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordProperty"
+ },
+ "nullable": true
+ },
+ "recordHistoryIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "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"
+ },
+ "GrantaServerApiDataExportDataExportResponse": {
+ "required": [
+ "failures",
+ "results"
+ ],
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportRecordWithData"
+ }
+ },
+ "failures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ "description": "List the records that were requested, but that we failed to export any data for."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsApplicableDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ }
+ ],
+ "properties": {
+ "notApplicable": {
+ "type": "string",
+ "default": "applicable"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsBooleanDatum\r\n * GrantaServerApiDataExportDatumsDateTimeDatum\r\n * GrantaServerApiDataExportDatumsDiscreteDatum\r\n * GrantaServerApiDataExportDatumsFileDatum\r\n * GrantaServerApiDataExportDatumsFloatFunctionalDatum\r\n * GrantaServerApiDataExportDatumsDiscreteFunctionalDatum\r\n * GrantaServerApiDataExportDatumsHyperlinkDatum\r\n * GrantaServerApiDataExportDatumsLinkDatum\r\n * GrantaServerApiDataExportDatumsLongTextDatum\r\n * GrantaServerApiDataExportDatumsNumericDatum\r\n * GrantaServerApiDataExportDatumsPictureDatum\r\n * GrantaServerApiDataExportDatumsPointDatum\r\n * GrantaServerApiDataExportDatumsRangeDatum\r\n * GrantaServerApiDataExportDatumsShortTextDatum",
+ "discriminator": {
+ "propertyName": "datumType",
+ "mapping": {
+ "logical": "#/components/schemas/GrantaServerApiDataExportDatumsBooleanDatum",
+ "dateTime": "#/components/schemas/GrantaServerApiDataExportDatumsDateTimeDatum",
+ "discrete": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteDatum",
+ "file": "#/components/schemas/GrantaServerApiDataExportDatumsFileDatum",
+ "floatFunctional": "#/components/schemas/GrantaServerApiDataExportDatumsFloatFunctionalDatum",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalDatum",
+ "hyperlink": "#/components/schemas/GrantaServerApiDataExportDatumsHyperlinkDatum",
+ "link": "#/components/schemas/GrantaServerApiDataExportDatumsLinkDatum",
+ "longText": "#/components/schemas/GrantaServerApiDataExportDatumsLongTextDatum",
+ "integer": "#/components/schemas/GrantaServerApiDataExportDatumsNumericDatum",
+ "picture": "#/components/schemas/GrantaServerApiDataExportDatumsPictureDatum",
+ "point": "#/components/schemas/GrantaServerApiDataExportDatumsPointDatum",
+ "range": "#/components/schemas/GrantaServerApiDataExportDatumsRangeDatum",
+ "shortText": "#/components/schemas/GrantaServerApiDataExportDatumsShortTextDatum"
+ }
+ },
+ "x-discriminator-value": "applicable"
+ },
+ "GrantaServerApiDataExportDatumsBinaryData": {
+ "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
+ },
+ "GrantaServerApiDataExportDatumsBooleanDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "logical"
+ },
+ "datumValue": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiDataExportDatumsDateTimeDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "dateTime"
+ },
+ "datumValue": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiDataExportDatumsDatum": {
+ "type": "object",
+ "properties": {
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "metaDatums": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsNotApplicableDatum\r\n * GrantaServerApiDataExportDatumsApplicableDatum\r\n * GrantaServerApiDataExportDatumsUnknownDatum",
+ "discriminator": {
+ "propertyName": "notApplicable",
+ "mapping": {
+ "notApplicable": "#/components/schemas/GrantaServerApiDataExportDatumsNotApplicableDatum",
+ "applicable": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum",
+ "unknown": "#/components/schemas/GrantaServerApiDataExportDatumsUnknownDatum"
+ }
+ }
+ },
+ "GrantaServerApiDataExportDatumsDiscreteDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "datumValue": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDiscreteValue"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteFunctionalDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ }
+ ],
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "xAxisParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsDiscreteFunctionalGridDatum\r\n * GrantaServerApiDataExportDatumsDiscreteFunctionalSeriesDatum",
+ "discriminator": {
+ "propertyName": "graphType",
+ "mapping": {
+ "grid": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalGridDatum",
+ "series": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalSeriesDatum"
+ }
+ },
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteFunctionalGridDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "grid"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteGridPoint"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDiscreteFunctionalDatum",
+ "x-discriminator-value": "grid"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteFunctionalSeriesDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "series"
+ },
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteSeries"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDiscreteFunctionalDatum",
+ "x-discriminator-value": "series"
+ },
+ "GrantaServerApiDataExportDatumsDiscreteGridPoint": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "value": {
+ "$ref": "#/components/schemas/GrantaServerApiDiscreteValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsDiscreteSeries": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDiscreteSeriesPoint"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsDiscreteSeriesPoint": {
+ "type": "object",
+ "properties": {
+ "x": {
+ "type": "number",
+ "format": "double"
+ },
+ "xName": {
+ "type": "string",
+ "nullable": true
+ },
+ "y": {
+ "$ref": "#/components/schemas/GrantaServerApiDiscreteValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsFileDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "file"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsBinaryData"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiDataExportDatumsFloatFunctionalDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ }
+ ],
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "xAxisParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiFunctionalDatumParameterInfo"
+ },
+ "nullable": true
+ },
+ "isEstimated": {
+ "type": "boolean"
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsFunctionalGridDatum\r\n * GrantaServerApiDataExportDatumsFunctionalSeriesDatum",
+ "discriminator": {
+ "propertyName": "graphType",
+ "mapping": {
+ "grid": "#/components/schemas/GrantaServerApiDataExportDatumsFunctionalGridDatum",
+ "series": "#/components/schemas/GrantaServerApiDataExportDatumsFunctionalSeriesDatum"
+ }
+ },
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiDataExportDatumsFunctionalGridDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsFloatFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "grid"
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsGridPoint"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsFloatFunctionalDatum",
+ "x-discriminator-value": "grid"
+ },
+ "GrantaServerApiDataExportDatumsFunctionalSeriesDatum": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsFloatFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "type": "string",
+ "default": "series"
+ },
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsSeries"
+ },
+ "nullable": true
+ },
+ "isLogarithmic": {
+ "type": "boolean"
+ },
+ "showAsTable": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsFloatFunctionalDatum",
+ "x-discriminator-value": "series"
+ },
+ "GrantaServerApiDataExportDatumsGraphDecoration": {
+ "enum": [
+ "Lines",
+ "Markers",
+ "LinesAndMarkers"
+ ],
+ "type": "string",
+ "description": "Indicates how a graphical representation of a graph should be renderedPossible values:
\r\n\r\n- Lines: Lines
\r\n- Markers: Markers
\r\n- LinesAndMarkers: Lines and Markers
\r\n
\r\n"
+ },
+ "GrantaServerApiDataExportDatumsGridPoint": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "low": {
+ "type": "number",
+ "format": "double"
+ },
+ "high": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsHyperlink": {
+ "type": "object",
+ "properties": {
+ "address": {
+ "type": "string",
+ "nullable": true
+ },
+ "formattedAddress": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsHyperlinkDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "hyperlink"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsHyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiDataExportDatumsLinkDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ }
+ ],
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "link"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsLinkedRecordsDatum\r\n * GrantaServerApiDataExportDatumsTabularDatum",
+ "discriminator": {
+ "propertyName": "linkDatumType",
+ "mapping": {
+ "linkGroup": "#/components/schemas/GrantaServerApiDataExportDatumsLinkedRecordsDatum",
+ "tabular": "#/components/schemas/GrantaServerApiDataExportDatumsTabularDatum"
+ }
+ },
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiDataExportDatumsLinkedRecordsDatum": {
+ "required": [
+ "linkDatumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsLinkDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "linkGroupName": {
+ "type": "string",
+ "nullable": true
+ },
+ "linkAttributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "exportInReversedDirection": {
+ "type": "boolean"
+ },
+ "targetDatabaseGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "linkedRecords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportRecordWithData"
+ },
+ "nullable": true
+ },
+ "linkGroupNamesByDatabaseKey": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "linkGroupIdentitiesByDatabaseKey": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "rolledUpData": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ "nullable": true
+ },
+ "linkDatumType": {
+ "type": "string",
+ "default": "linkGroup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsLinkDatum",
+ "x-discriminator-value": "linkGroup"
+ },
+ "GrantaServerApiDataExportDatumsLongTextDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "longText"
+ },
+ "datumValue": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiDataExportDatumsNotApplicableDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "notApplicable": {
+ "type": "string",
+ "default": "notApplicable"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDatum",
+ "x-discriminator-value": "notApplicable"
+ },
+ "GrantaServerApiDataExportDatumsNumericDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "integer"
+ },
+ "datumValue": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiDataExportDatumsParameterValue": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfo"
+ },
+ "valueName": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsPictureDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "picture"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsBinaryData"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiDataExportDatumsPoint": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsPointDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "point"
+ },
+ "datumValue": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsPoint"
+ },
+ "nullable": true
+ },
+ "isEstimated": {
+ "type": "boolean"
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiDataExportDatumsRange": {
+ "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
+ },
+ "GrantaServerApiDataExportDatumsRangeDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "range"
+ },
+ "datumValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRange"
+ },
+ "isEstimated": {
+ "type": "boolean"
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiDataExportDatumsRollupCountRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "countRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A count of the number of populated values\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "countRollup"
+ },
+ "GrantaServerApiDataExportDatumsRollupNumericRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "statisticalRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A statistical rollup of a set of numeric values\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "statisticalRollup"
+ },
+ "GrantaServerApiDataExportDatumsRollupRollupDatum": {
+ "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/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportDatumsRollupNumericRollupDatum\r\n * GrantaServerApiDataExportDatumsRollupValueRollupDatum\r\n * GrantaServerApiDataExportDatumsRollupValuesRollupDatum\r\n * GrantaServerApiDataExportDatumsRollupCountRollupDatum",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "statisticalRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupNumericRollupDatum",
+ "valueRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupValueRollupDatum",
+ "valuesRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupValuesRollupDatum",
+ "countRollup": "#/components/schemas/GrantaServerApiDataExportDatumsRollupCountRollupDatum"
+ }
+ }
+ },
+ "GrantaServerApiDataExportDatumsRollupValueRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "object",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "valueRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A rollup where the value is a single object (such as a discrete value)\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "valueRollup"
+ },
+ "GrantaServerApiDataExportDatumsRollupValuesRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "nullable": true
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "valuesRollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "A rollup to a list of values\r\n\r\nThis extends: GrantaServerApiDataExportDatumsRollupRollupDatum",
+ "x-discriminator-value": "valuesRollup"
+ },
+ "GrantaServerApiDataExportDatumsSeries": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ },
+ "nullable": true
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsSeriesPoint"
+ },
+ "nullable": true
+ },
+ "graphDecoration": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsGraphDecoration"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsSeriesPoint": {
+ "type": "object",
+ "properties": {
+ "x": {
+ "type": "number",
+ "format": "double"
+ },
+ "xName": {
+ "type": "string",
+ "nullable": true
+ },
+ "yLow": {
+ "type": "number",
+ "format": "double"
+ },
+ "yHigh": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsShortTextDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "datumValue": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsApplicableDatum",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiDataExportDatumsTabularDatum": {
+ "required": [
+ "linkDatumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsLinkDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeName": {
+ "type": "string",
+ "nullable": true
+ },
+ "tabularRows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsTabularRow"
+ },
+ "nullable": true
+ },
+ "summaryRow": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ "nullable": true
+ },
+ "linkDatumType": {
+ "type": "string",
+ "default": "tabular"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsLinkDatum",
+ "x-discriminator-value": "tabular"
+ },
+ "GrantaServerApiDataExportDatumsTabularRow": {
+ "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/GrantaServerApiDataExportDatumsDatum"
+ },
+ "nullable": true
+ },
+ "linkedRecords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportRecordReference"
+ },
+ "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/GrantaServerApiDataExportRecordWithData"
+ },
+ "description": "Data for the linked records, if the request included linked data to export",
+ "nullable": true
+ },
+ "rolledUpData": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsRollupRollupDatum"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportDatumsUnknownDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "notApplicable": {
+ "type": "string",
+ "default": "unknown"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportDatumsDatum",
+ "x-discriminator-value": "unknown"
+ },
+ "GrantaServerApiDataExportExportFailuresAttributeExportFailure": {
+ "required": [
+ "failedAttributes",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresAttributeReference"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiDataExportExportFailuresAttributeReference": {
+ "required": [
+ "databaseKey"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true,
+ "readOnly": true
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true,
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportExportFailuresDatumExportFailure": {
+ "required": [
+ "failedDatum",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedDatum": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresDatumReference"
+ },
+ "type": {
+ "type": "string",
+ "default": "datum"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "datum"
+ },
+ "GrantaServerApiDataExportExportFailuresDatumReference": {
+ "required": [
+ "attributeIdentity",
+ "databaseKey",
+ "recordHistoryIdentity"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportExportFailuresExportFailure": {
+ "required": [
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "failureDetails": {
+ "type": "string"
+ },
+ "failureReason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportExportFailuresRecordExportFailure\r\n * GrantaServerApiDataExportExportFailuresLinkExportFailure\r\n * GrantaServerApiDataExportExportFailuresAttributeExportFailure\r\n * GrantaServerApiDataExportExportFailuresDatumExportFailure\r\n * GrantaServerApiDataExportExportFailuresRollupExportFailure",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "record": "#/components/schemas/GrantaServerApiDataExportExportFailuresRecordExportFailure",
+ "link": "#/components/schemas/GrantaServerApiDataExportExportFailuresLinkExportFailure",
+ "attribute": "#/components/schemas/GrantaServerApiDataExportExportFailuresAttributeExportFailure",
+ "datum": "#/components/schemas/GrantaServerApiDataExportExportFailuresDatumExportFailure",
+ "rollup": "#/components/schemas/GrantaServerApiDataExportExportFailuresRollupExportFailure"
+ }
+ }
+ },
+ "GrantaServerApiDataExportExportFailuresExportFailureType": {
+ "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"
+ },
+ "GrantaServerApiDataExportExportFailuresLinkExportFailure": {
+ "required": [
+ "failedLink",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedLink": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresLinkReference"
+ },
+ "type": {
+ "type": "string",
+ "default": "link"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiDataExportExportFailuresLinkReference": {
+ "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/GrantaServerApiLinkAttributeType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportExportFailuresRecordExportFailure": {
+ "required": [
+ "failedRecords",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedRecords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportRecordReference"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "record"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "record"
+ },
+ "GrantaServerApiDataExportExportFailuresRollupExportFailure": {
+ "required": [
+ "failedRollup",
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresExportFailure"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "failedRollup": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportExportFailuresRollupReference"
+ },
+ "type": {
+ "type": "string",
+ "default": "rollup"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportExportFailuresExportFailure",
+ "x-discriminator-value": "rollup"
+ },
+ "GrantaServerApiDataExportExportFailuresRollupReference": {
+ "required": [
+ "databaseKey",
+ "rollupType"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "rollupType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportLinkAttributeToExport": {
+ "required": [
+ "attributeType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localData": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportSimpleAttributeToExport"
+ },
+ "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": {
+ "type": "string",
+ "description": "For tabular searching: this is the identifier of the short-text linking attribute.\r\nOtherwise null.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "attributeType": {
+ "type": "string",
+ "default": "link"
+ },
+ "linkAttributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "exportInReversedDirection": {
+ "type": "boolean"
+ },
+ "recordProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordProperty"
+ },
+ "description": "The properties to export on any linked records.",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ "description": "The attributes to export on any linked records.",
+ "nullable": true
+ },
+ "linkedRecordsExportBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportLinkedRecordExportBehavior"
+ },
+ "indirectLinksBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiIndirectLinks"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Export request information for a 'link' attribute.\r\n\r\nThis extends: GrantaServerApiDataExportAttributeToExport",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiDataExportLinkedRecordExportBehavior": {
+ "type": "object",
+ "properties": {
+ "tabularRowBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportTabularRowExportBehavior"
+ },
+ "summaryRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "linkedRecordsCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiDataExportParameterSettingDefinedAt": {
+ "enum": [
+ "parameter",
+ "attribute",
+ "datum"
+ ],
+ "type": "string",
+ "description": "Possible values:
\r\n\r\n- ParameterLevel: Parameter Level
\r\n- AttributeLevel: Attribute Level
\r\n- DatumLevel: Datum Level
\r\n
\r\n"
+ },
+ "GrantaServerApiDataExportPropertiesCreatedByUserProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "createdByUser"
+ },
+ "createdByUser": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "createdByUser"
+ },
+ "GrantaServerApiDataExportPropertiesCreatedDateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "createdDate"
+ },
+ "createdDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "createdDate"
+ },
+ "GrantaServerApiDataExportPropertiesDatabaseKeyProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "databaseKey"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "databaseKey"
+ },
+ "GrantaServerApiDataExportPropertiesFullNameProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "fullName"
+ },
+ "fullName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "fullName"
+ },
+ "GrantaServerApiDataExportPropertiesLastModifiedByUserProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "lastModifiedByUser"
+ },
+ "lastModifiedByUser": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "lastModifiedByUser"
+ },
+ "GrantaServerApiDataExportPropertiesLastModifiedDateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "lastModifiedDate"
+ },
+ "lastModifiedDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "lastModifiedDate"
+ },
+ "GrantaServerApiDataExportPropertiesProperty": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataExportPropertiesCreatedByUserProperty\r\n * GrantaServerApiDataExportPropertiesCreatedDateProperty\r\n * GrantaServerApiDataExportPropertiesDatabaseKeyProperty\r\n * GrantaServerApiDataExportPropertiesFullNameProperty\r\n * GrantaServerApiDataExportPropertiesLastModifiedDateProperty\r\n * GrantaServerApiDataExportPropertiesLastModifiedByUserProperty\r\n * GrantaServerApiDataExportPropertiesRecordColorProperty\r\n * GrantaServerApiDataExportPropertiesRecordGuidProperty\r\n * GrantaServerApiDataExportPropertiesRecordIdentityProperty\r\n * GrantaServerApiDataExportPropertiesRecordHistoryGuidProperty\r\n * GrantaServerApiDataExportPropertiesRecordHistoryIdentityProperty\r\n * GrantaServerApiDataExportPropertiesRecordTypeProperty\r\n * GrantaServerApiDataExportPropertiesReleasedDateProperty\r\n * GrantaServerApiDataExportPropertiesShortNameProperty\r\n * GrantaServerApiDataExportPropertiesTableGuidProperty\r\n * GrantaServerApiDataExportPropertiesTableIdentityProperty\r\n * GrantaServerApiDataExportPropertiesTableNameProperty\r\n * GrantaServerApiDataExportPropertiesVersionNumberProperty\r\n * GrantaServerApiDataExportPropertiesVersionStateProperty",
+ "discriminator": {
+ "propertyName": "propertyName",
+ "mapping": {
+ "createdByUser": "#/components/schemas/GrantaServerApiDataExportPropertiesCreatedByUserProperty",
+ "createdDate": "#/components/schemas/GrantaServerApiDataExportPropertiesCreatedDateProperty",
+ "databaseKey": "#/components/schemas/GrantaServerApiDataExportPropertiesDatabaseKeyProperty",
+ "fullName": "#/components/schemas/GrantaServerApiDataExportPropertiesFullNameProperty",
+ "lastModifiedDate": "#/components/schemas/GrantaServerApiDataExportPropertiesLastModifiedDateProperty",
+ "lastModifiedByUser": "#/components/schemas/GrantaServerApiDataExportPropertiesLastModifiedByUserProperty",
+ "recordColor": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordColorProperty",
+ "recordGuid": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordGuidProperty",
+ "recordIdentity": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordIdentityProperty",
+ "recordHistoryGuid": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordHistoryGuidProperty",
+ "recordHistoryIdentity": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordHistoryIdentityProperty",
+ "recordType": "#/components/schemas/GrantaServerApiDataExportPropertiesRecordTypeProperty",
+ "releasedDate": "#/components/schemas/GrantaServerApiDataExportPropertiesReleasedDateProperty",
+ "shortName": "#/components/schemas/GrantaServerApiDataExportPropertiesShortNameProperty",
+ "tableGuid": "#/components/schemas/GrantaServerApiDataExportPropertiesTableGuidProperty",
+ "tableIdentity": "#/components/schemas/GrantaServerApiDataExportPropertiesTableIdentityProperty",
+ "tableName": "#/components/schemas/GrantaServerApiDataExportPropertiesTableNameProperty",
+ "versionNumber": "#/components/schemas/GrantaServerApiDataExportPropertiesVersionNumberProperty",
+ "versionState": "#/components/schemas/GrantaServerApiDataExportPropertiesVersionStateProperty"
+ }
+ }
+ },
+ "GrantaServerApiDataExportPropertiesRecordColorProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordColor"
+ },
+ "recordColor": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordColor"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordColor"
+ },
+ "GrantaServerApiDataExportPropertiesRecordGuidProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordGuid"
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordGuid"
+ },
+ "GrantaServerApiDataExportPropertiesRecordHistoryGuidProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordHistoryGuid"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordHistoryGuid"
+ },
+ "GrantaServerApiDataExportPropertiesRecordHistoryIdentityProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordHistoryIdentity"
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordHistoryIdentity"
+ },
+ "GrantaServerApiDataExportPropertiesRecordIdentityProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordIdentity"
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordIdentity"
+ },
+ "GrantaServerApiDataExportPropertiesRecordTypeProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "recordType"
+ },
+ "recordType": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "recordType"
+ },
+ "GrantaServerApiDataExportPropertiesReleasedDateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "releasedDate"
+ },
+ "releasedDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "releasedDate"
+ },
+ "GrantaServerApiDataExportPropertiesShortNameProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "shortName"
+ },
+ "shortName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "shortName"
+ },
+ "GrantaServerApiDataExportPropertiesTableGuidProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "tableGuid"
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "tableGuid"
+ },
+ "GrantaServerApiDataExportPropertiesTableIdentityProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "tableIdentity"
+ },
+ "tableIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "tableIdentity"
+ },
+ "GrantaServerApiDataExportPropertiesTableNameProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "tableName"
+ },
+ "tableName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "tableName"
+ },
+ "GrantaServerApiDataExportPropertiesVersionNumberProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "versionNumber"
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "versionNumber"
+ },
+ "GrantaServerApiDataExportPropertiesVersionStateProperty": {
+ "required": [
+ "propertyName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "propertyName": {
+ "type": "string",
+ "default": "versionState"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportPropertiesProperty",
+ "x-discriminator-value": "versionState"
+ },
+ "GrantaServerApiDataExportRecordWithData": {
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsDatum"
+ },
+ "nullable": true
+ },
+ "properties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportPropertiesProperty"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataExportSimpleAttributeToExport": {
+ "required": [
+ "attributeType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportAttributeToExport"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "attributeType": {
+ "type": "string",
+ "default": "simple"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataExportAttributeToExport",
+ "x-discriminator-value": "simple"
+ },
+ "GrantaServerApiDataExportTabularRowExportBehavior": {
+ "enum": [
+ "allRows",
+ "onlyRowsWithVisibleLinkedRecords"
+ ],
+ "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"
+ },
+ "GrantaServerApiDataFileDatum": {
+ "required": [
+ "contentIsInSearchIndex",
+ "contentType",
+ "datumType",
+ "description",
+ "fileName",
+ "target"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "file"
+ },
+ "fileName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "contentType": {
+ "type": "string"
+ },
+ "target": {
+ "type": "string"
+ },
+ "contentIsInSearchIndex": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiDataHyperlinkDatum": {
+ "required": [
+ "address",
+ "datumType",
+ "description",
+ "target"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "hyperlink"
+ },
+ "address": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GrantaServerApiDataHyperlinkTarget"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiDataHyperlinkTarget": {
+ "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"
+ },
+ "GrantaServerApiDataIntegerDatum": {
+ "required": [
+ "datumType",
+ "value"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "integer"
+ },
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiDataLogicalDatum": {
+ "required": [
+ "datumType",
+ "value"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "logical"
+ },
+ "value": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiDataLongTextDatum": {
+ "required": [
+ "datumType",
+ "richTextValue"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "longText"
+ },
+ "richTextValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataRichTextValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiDataNotApplicableDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "notApplicable": {
+ "type": "string",
+ "default": "notApplicable"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataDatum",
+ "x-discriminator-value": "notApplicable"
+ },
+ "GrantaServerApiDataNumericParameterWithValue": {
+ "required": [
+ "parameter",
+ "parameterValue",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataParameterWithValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "parameterValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataParameterWithValue",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiDataParameterWithValue": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiDataDiscreteParameterWithValue\r\n * GrantaServerApiDataNumericParameterWithValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiDataDiscreteParameterWithValue",
+ "numeric": "#/components/schemas/GrantaServerApiDataNumericParameterWithValue"
+ }
+ }
+ },
+ "GrantaServerApiDataPictureDatum": {
+ "required": [
+ "datumType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiDataPointDataValue": {
+ "required": [
+ "parameterAndValues",
+ "pointValue"
+ ],
+ "type": "object",
+ "properties": {
+ "pointValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "significantFiguresInfo": {
+ "$ref": "#/components/schemas/GrantaServerApiDataSignificantFiguresInfo"
+ },
+ "parameterAndValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataParameterWithValue"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataPointDatum": {
+ "required": [
+ "datumType",
+ "estimated",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "point"
+ },
+ "estimated": {
+ "type": "boolean"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiDataPointDataValue"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiDataRangeDatum": {
+ "required": [
+ "datumType",
+ "estimated",
+ "highValue",
+ "highValueIsInclusive",
+ "lowValue",
+ "lowValueIsInclusive"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "range"
+ },
+ "lowValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "lowValueIsInclusive": {
+ "type": "boolean"
+ },
+ "highValueIsInclusive": {
+ "type": "boolean"
+ },
+ "lowValueSignificantFiguresInfo": {
+ "$ref": "#/components/schemas/GrantaServerApiDataSignificantFiguresInfo"
+ },
+ "highValueSignificantFiguresInfo": {
+ "$ref": "#/components/schemas/GrantaServerApiDataSignificantFiguresInfo"
+ },
+ "estimated": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiDataRichTextType": {
+ "enum": [
+ "plain",
+ "markdown"
+ ],
+ "type": "string",
+ "description": "The types of datum that are supported by the API.Possible values:
\r\n\r\n- Plain: Represents plain text.
\r\n- Markdown: (no description available)
\r\n
\r\n"
+ },
+ "GrantaServerApiDataRichTextValue": {
+ "required": [
+ "text",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiDataRichTextType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDataShortTextDatum": {
+ "required": [
+ "datumType",
+ "value"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiDataApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiDataApplicableDatum",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiDataSignificantFiguresInfo": {
+ "required": [
+ "enteredValue",
+ "significantFigures"
+ ],
+ "type": "object",
+ "properties": {
+ "significantFigures": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "enteredValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "enteredUnit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDatabaseStatus": {
+ "enum": [
+ "Unknown",
+ "Ok",
+ "Unloaded",
+ "Loading",
+ "Unloading",
+ "FailedToLoad",
+ "FailedToUnload",
+ "Disabled"
+ ],
+ "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
\r\n"
+ },
+ "GrantaServerApiDatabaseStatusInformation": {
+ "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."
+ },
+ "state": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatus"
+ },
+ "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
+ },
+ "GrantaServerApiDiscreteValue": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "order": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiDiskStatus": {
+ "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"
+ },
+ "GrantaServerApiExceptionsDataModificationDataModificationErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiExceptionsDataModificationInUseDataModificationErrorDetail",
+ "discriminator": {
+ "propertyName": "reason",
+ "mapping": {
+ "inUse": "#/components/schemas/GrantaServerApiExceptionsDataModificationInUseDataModificationErrorDetail"
+ }
+ }
+ },
+ "GrantaServerApiExceptionsDataModificationInUseDataModificationErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "referencedByType": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationReferencedByType"
+ },
+ "referencedBy": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "reason": {
+ "type": "string",
+ "default": "inUse"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiExceptionsDataModificationDataModificationErrorDetail",
+ "x-discriminator-value": "inUse"
+ },
+ "GrantaServerApiExceptionsDataModificationReferencedByType": {
+ "enum": [
+ "unknown",
+ "expression",
+ "versionControlledData",
+ "dynamicLinkGroup",
+ "tabularAttribute",
+ "xyChartTemplate",
+ "searchMask",
+ "securityAttribute",
+ "attribute",
+ "data",
+ "defaultParameterValue"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiExceptionsDeletionAttributeDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDeletionConstantDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDeletionDiscreteTypeDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDeletionDiscreteValueDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDeletionParameterDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDeletionParameterValueDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsDeletionTableDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsDataModificationDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsRecordHistoryRecordHistoryCopyException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsRecordHistoryRecordHistoryMoveException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsVersionControlGetModifiableRecordVersionControlException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsVersionControlInvalidParentStateErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "default": "invalidParentState"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiExceptionsVersionControlVersionControlErrorDetail",
+ "x-discriminator-value": "invalidParentState"
+ },
+ "GrantaServerApiExceptionsVersionControlInvalidVersionStateErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ },
+ "reason": {
+ "type": "string",
+ "default": "invalidVersionState"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiExceptionsVersionControlVersionControlErrorDetail",
+ "x-discriminator-value": "invalidVersionState"
+ },
+ "GrantaServerApiExceptionsVersionControlNotTheLatestVersionErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "newerVersion": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordVersionsSlimRecordVersion"
+ },
+ "reason": {
+ "type": "string",
+ "default": "notTheLatestVersion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiExceptionsVersionControlVersionControlErrorDetail",
+ "x-discriminator-value": "notTheLatestVersion"
+ },
+ "GrantaServerApiExceptionsVersionControlNotVersionedErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "default": "notVersioned"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiExceptionsVersionControlVersionControlErrorDetail",
+ "x-discriminator-value": "notVersioned"
+ },
+ "GrantaServerApiExceptionsVersionControlReleaseRecordVersionControlException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsVersionControlReleaseTableVersionControlException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExceptionsVersionControlVersionControlErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiExceptionsVersionControlInvalidVersionStateErrorDetail\r\n * GrantaServerApiExceptionsVersionControlNotTheLatestVersionErrorDetail\r\n * GrantaServerApiExceptionsVersionControlInvalidParentStateErrorDetail\r\n * GrantaServerApiExceptionsVersionControlNotVersionedErrorDetail",
+ "discriminator": {
+ "propertyName": "reason",
+ "mapping": {
+ "invalidVersionState": "#/components/schemas/GrantaServerApiExceptionsVersionControlInvalidVersionStateErrorDetail",
+ "notTheLatestVersion": "#/components/schemas/GrantaServerApiExceptionsVersionControlNotTheLatestVersionErrorDetail",
+ "invalidParentState": "#/components/schemas/GrantaServerApiExceptionsVersionControlInvalidParentStateErrorDetail",
+ "notVersioned": "#/components/schemas/GrantaServerApiExceptionsVersionControlNotVersionedErrorDetail"
+ }
+ }
+ },
+ "GrantaServerApiExceptionsVersionControlWithdrawRecordVersionControlException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiExceptionsVersionControlVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiExcludeValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "excludedIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "excludedGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "filterOn": {
+ "type": "string",
+ "default": "exclude"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "exclude"
+ },
+ "GrantaServerApiFunctionalDatumParameterInfo": {
+ "type": "object",
+ "properties": {
+ "scaleTypeDefinedAt": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportParameterSettingDefinedAt"
+ },
+ "interpolationMethodDefinedAt": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportParameterSettingDefinedAt"
+ },
+ "defaultValueDefinedAt": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportParameterSettingDefinedAt"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIndexRecordFailure": {
+ "type": "object",
+ "properties": {
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "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": "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."
+ },
+ "GrantaServerApiIndirectLinks": {
+ "enum": [
+ "fromLinkDefinition",
+ "include",
+ "exclude"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiIntegrationDataExportIntegrationDataExportRequest": {
+ "required": [
+ "attributeIdentities",
+ "recordReferences"
+ ],
+ "type": "object",
+ "properties": {
+ "recordReferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationDataExportRecordReference"
+ },
+ "description": "A list of records to export. These are references to the underlying records in the source database"
+ },
+ "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
+ },
+ "GrantaServerApiIntegrationDataExportRecordReference": {
+ "type": "object",
+ "properties": {
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "The unique way to identify a record history (which may have multiple versions) in an MI system"
+ },
+ "GrantaServerApiIntegrationIntegrationSchemaStatus": {
+ "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
+ },
+ "erroredDatabases": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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/GrantaServerApiSearchIndexStatus"
+ },
+ "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,
+ "readOnly": 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
+ },
+ "diskStatus": {
+ "$ref": "#/components/schemas/GrantaServerApiDiskStatus"
+ },
+ "diskThreshold": {
+ "type": "string",
+ "description": "The 'flood stage' threshold from Elasticsearch.",
+ "nullable": true
+ },
+ "searchIndexUnavailable": {
+ "type": "boolean",
+ "description": "True if the index could not be contacted.",
+ "nullable": true
+ },
+ "recordsThatFailedToIndex": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIndexRecordFailure"
+ },
+ "description": "Details of any records that failed to index.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
+ "type": "string",
+ "description": "Set as nullable for older schema compatibility,\r\nbut we expect it to be set almost everywhere,\r\nexcept during loading from disk.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "description": "If isUnitted is true, then this must have a non empty value",
+ "nullable": true
+ },
+ "isUnitted": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "discreteTypeIdentity": {
+ "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/GrantaServerApiIntegrationSchemaIntegrationParameterInfo"
+ },
+ "description": "A float functional attribute must define a list of parameters.",
+ "nullable": true
+ },
+ "targetDatabase": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "targetTable": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaDiscreteType": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGeneratedIntegrationSchemaOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "warnings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaIntegrationSchemaGenerationErrorDetail"
+ },
+ "nullable": true
+ },
+ "schema": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "unitSymbol": {
+ "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
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationParameterInfo"
+ },
+ "description": "A float functional attribute must define a list of parameters.",
+ "nullable": true
+ },
+ "targetDatabase": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "targetTable": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyDiscreteType": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationParameterInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyIntegrationSchemaOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "nullable": true
+ },
+ "version": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyAttribute"
+ },
+ "nullable": true
+ },
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyLayout"
+ },
+ "nullable": true
+ },
+ "unitSystem": {
+ "type": "string",
+ "nullable": true
+ },
+ "discreteTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyDiscreteType"
+ },
+ "nullable": true
+ },
+ "sources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlySourceOfGrantaServerApiObjectIdentifier"
+ },
+ "nullable": true
+ },
+ "accessControlCategoryValues": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "securityGroups": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSecurityGroups"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Similar to IntegrationSchema, but without identities.\r\nUsed when we don't want consumers to specify/know about identities."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyMappingOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "targetGuid": {
+ "type": "string",
+ "description": "The guid of the integration schema attribute",
+ "format": "uuid"
+ },
+ "parameterMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "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/GrantaServerApiIntegrationSchemaLinkSourceType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A mapping between a source database item and an integration schema attribute."
+ },
+ "GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlySourceOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "database": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "mappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaGuidOnlySchemaGuidOnlyMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "description": "Mappings for items from this table to the integration schema attributes.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "A source table from which integrated data will be taken."
+ },
+ "GrantaServerApiIntegrationSchemaIntegrationParameterInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaIntegrationSchemaGenerationErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiIntegrationSchemaIntegrationSchemaOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "nullable": true
+ },
+ "version": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaAttribute"
+ },
+ "nullable": true
+ },
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaLayout"
+ },
+ "nullable": true
+ },
+ "unitSystem": {
+ "type": "string",
+ "nullable": true
+ },
+ "discreteTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaDiscreteType"
+ },
+ "nullable": true
+ },
+ "sources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier"
+ },
+ "nullable": true
+ },
+ "accessControlCategoryValues": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "securityGroups": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaSecurityGroups"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "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."
+ },
+ "GrantaServerApiIntegrationSchemaLinkSourceType": {
+ "enum": [
+ "recordLink",
+ "crossDatabaseLink",
+ "reverseCrossDatabaseLink"
+ ],
+ "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"
+ },
+ "GrantaServerApiIntegrationSchemaMappingOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "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",
+ "nullable": true
+ },
+ "parameterMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "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/GrantaServerApiIntegrationSchemaLinkSourceType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A mapping between a source database item and an integration schema attribute."
+ },
+ "GrantaServerApiIntegrationSchemaSecurityGroups": {
+ "type": "object",
+ "properties": {
+ "readGroup": {
+ "type": "string",
+ "description": "Members of this groups can read data from the integration schema.",
+ "nullable": true
+ },
+ "adminGroup": {
+ "type": "string",
+ "description": "Members of this group can perform administrative tasks such as adding or deleting the schema.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "The security groups that apply to an integration schema. If null or empty, the default MI security groups will be used."
+ },
+ "GrantaServerApiIntegrationSchemaSourceOfGrantaServerApiObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "database": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ },
+ "mappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIntegrationSchemaMappingOfGrantaServerApiObjectIdentifier"
+ },
+ "description": "Mappings for items from this table to the integration schema attributes.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "A source table from which integrated data will be taken."
+ },
+ "GrantaServerApiLinkAttributeType": {
+ "enum": [
+ "recordLink",
+ "crossDatabaseLink",
+ "dynamicLink",
+ "tabularAttribute"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiListsDtoCreateListItem": {
+ "required": [
+ "databaseGuid",
+ "recordHistoryGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordVersion": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoCreateRecordList": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateRecordListItemsInfo"
+ },
+ "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
+ },
+ "GrantaServerApiListsDtoCreateRecordListItemsInfo": {
+ "required": [
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoCreateListItem"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoDeleteRecordListItem": {
+ "required": [
+ "databaseGuid",
+ "recordHistoryGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordVersion": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoDeleteRecordListItems": {
+ "required": [
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoDeleteRecordListItem"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoListBooleanCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "matchAny": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ "nullable": true
+ },
+ "matchAll": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "listBoolean"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiListsDtoListCriterion",
+ "x-discriminator-value": "listBoolean"
+ },
+ "GrantaServerApiListsDtoListCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiListsDtoListBooleanCriterion\r\n * GrantaServerApiListsDtoRecordListSearchCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "listBoolean": "#/components/schemas/GrantaServerApiListsDtoListBooleanCriterion",
+ "recordList": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchCriterion"
+ }
+ }
+ },
+ "GrantaServerApiListsDtoListItem": {
+ "required": [
+ "databaseGuid",
+ "recordHistoryGuid",
+ "tableGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordVersion": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoPagingOptions": {
+ "type": "object",
+ "properties": {
+ "startIndex": {
+ "type": "integer",
+ "description": "The index of the first list in the collection to be returned. If not provided it will start at index 0.",
+ "format": "int32",
+ "nullable": true
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The number of lists to be returned per page. If not provided the number of returned lists will be unlimited.",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListHeader": {
+ "required": [
+ "awaitingApproval",
+ "createdTimestamp",
+ "createdUser",
+ "identifier",
+ "internalUse",
+ "isRevision",
+ "lastModifiedTimestamp",
+ "lastModifiedUser",
+ "metadata",
+ "name",
+ "published"
+ ],
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "parentRecordListIdentifier": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdUser": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserOrGroup"
+ },
+ "lastModifiedTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedUser": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserOrGroup"
+ },
+ "publishedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "publishedUser": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserOrGroup"
+ },
+ "isRevision": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "published": {
+ "type": "boolean"
+ },
+ "awaitingApproval": {
+ "type": "boolean"
+ },
+ "internalUse": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListHeadersInfo": {
+ "required": [
+ "lists"
+ ],
+ "type": "object",
+ "properties": {
+ "lists": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListItemsInfo": {
+ "required": [
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListItem"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListPermissionFlags": {
+ "required": [
+ "isAdministrator",
+ "isCurator",
+ "isOwner",
+ "isPublisher",
+ "isSubscribed"
+ ],
+ "type": "object",
+ "properties": {
+ "isOwner": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an owner of this list."
+ },
+ "isSubscribed": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is subscribed to this list."
+ },
+ "isCurator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is a curator of this list."
+ },
+ "isAdministrator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an administrator of this list."
+ },
+ "isPublisher": {
+ "type": "boolean",
+ "description": "Flag indicating if this user or group is a publisher of this list."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListSearchCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "nameContains": {
+ "type": "string",
+ "nullable": true
+ },
+ "userRole": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserRole"
+ },
+ "isPublished": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isAwaitingApproval": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isInternalUse": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isRevision": {
+ "type": "boolean",
+ "description": "Restrict to record lists that are (non discarded) revisions.",
+ "nullable": true
+ },
+ "containsRecordsInDatabases": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing records in any of of the specified databases",
+ "nullable": true
+ },
+ "containsRecordsInIntegrationSchemas": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Limits results to lists containing records in any of the specified integration schemas",
+ "nullable": true
+ },
+ "containsRecordsInTables": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing records in any of the specified tables",
+ "nullable": true
+ },
+ "containsRecords": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing any of the given records",
+ "nullable": true
+ },
+ "userCanAddOrRemoveItems": {
+ "type": "boolean",
+ "description": "Limits results to lists where the current user can add or remove items.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordList"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiListsDtoListCriterion",
+ "x-discriminator-value": "recordList"
+ },
+ "GrantaServerApiListsDtoRecordListSearchInfo": {
+ "required": [
+ "searchResultIdentifier"
+ ],
+ "type": "object",
+ "properties": {
+ "searchResultIdentifier": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListSearchRequest": {
+ "required": [
+ "searchCriterion"
+ ],
+ "type": "object",
+ "properties": {
+ "searchCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListCriterion"
+ },
+ "pagingOptions": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoPagingOptions"
+ },
+ "responseOptions": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoResponseOptions"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListSearchResult": {
+ "required": [
+ "header",
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "header": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListHeader"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoListItem"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoRecordListSearchResultsInfo": {
+ "required": [
+ "searchResults"
+ ],
+ "type": "object",
+ "properties": {
+ "searchResults": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListSearchResult"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoResponseOptions": {
+ "type": "object",
+ "properties": {
+ "includeUserActions": {
+ "type": "boolean"
+ },
+ "includeUserPermissions": {
+ "type": "boolean"
+ },
+ "includeRecordListItems": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUpdateRecordListPermissionFlags": {
+ "required": [
+ "isAdministrator",
+ "isCurator",
+ "isPublisher",
+ "isSubscribed"
+ ],
+ "type": "object",
+ "properties": {
+ "isSubscribed": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is subscribed to this list."
+ },
+ "isCurator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is a curator of this list."
+ },
+ "isAdministrator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an administrator of this list."
+ },
+ "isPublisher": {
+ "type": "boolean",
+ "description": "Flag indicating if this user or group is a publisher of this list."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUpdateRecordListProperties": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "published": {
+ "type": "boolean"
+ },
+ "awaitingApproval": {
+ "type": "boolean"
+ },
+ "internalUse": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUpdateUserPermission": {
+ "required": [
+ "flags",
+ "userOrGroupIdentifier"
+ ],
+ "type": "object",
+ "properties": {
+ "userOrGroupIdentifier": {
+ "type": "string",
+ "description": "The user or group identifier",
+ "format": "uuid"
+ },
+ "flags": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateRecordListPermissionFlags"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUpdateUserPermissionsInfo": {
+ "required": [
+ "userPermissions"
+ ],
+ "type": "object",
+ "properties": {
+ "userPermissions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUpdateUserPermission"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserOrGroup": {
+ "required": [
+ "displayName",
+ "identifier",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayName": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserPermission": {
+ "required": [
+ "flags",
+ "userOrGroupIdentifier",
+ "userOrGroupName"
+ ],
+ "type": "object",
+ "properties": {
+ "userOrGroupName": {
+ "type": "string",
+ "description": "The user or group name."
+ },
+ "userOrGroupIdentifier": {
+ "type": "string",
+ "description": "The user or group identifier",
+ "format": "uuid"
+ },
+ "flags": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoRecordListPermissionFlags"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserPermissionsInfo": {
+ "required": [
+ "userPermissions"
+ ],
+ "type": "object",
+ "properties": {
+ "userPermissions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiListsDtoUserPermission"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiListsDtoUserRole": {
+ "enum": [
+ "None",
+ "Owner",
+ "Subscriber",
+ "Curator",
+ "Administrator",
+ "Publisher"
+ ],
+ "type": "string",
+ "description": "A set of flags that can be used to describe the role or roles that a user has on a particular record list"
+ },
+ "GrantaServerApiMetricsGetJobsSummaryResponse": {
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiMetricsJobTypeAndStatus"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiMetricsJobTypeAndStatus": {
+ "type": "object",
+ "properties": {
+ "jobType": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiNoValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filterOn": {
+ "type": "string",
+ "default": "none"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Used to return no values.\r\n\r\nThis extends: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "none"
+ },
+ "GrantaServerApiObjectIdentifier": {
+ "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."
+ },
+ "GrantaServerApiParameterInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoScaleType"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoInterpolationType"
+ },
+ "parameterType": {
+ "$ref": "#/components/schemas/GrantaServerApiParameterInfoParameterType"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GrantaServerApiDataExportDatumsParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiParameterInfoInterpolationType": {
+ "enum": [
+ "auto",
+ "none",
+ "linear",
+ "cubicSpline"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiParameterInfoParameterType": {
+ "enum": [
+ "discrete",
+ "numericRestricted",
+ "numericUnrestricted"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiParameterInfoScaleType": {
+ "enum": [
+ "notSet",
+ "linear",
+ "log"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiRecordColor": {
+ "enum": [
+ "red",
+ "lime",
+ "blue",
+ "yellow",
+ "fuchsia",
+ "aqua",
+ "maroon",
+ "green",
+ "navy",
+ "olive",
+ "purple",
+ "teal",
+ "gray",
+ "black",
+ "white",
+ "silver"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the supported record colors."
+ },
+ "GrantaServerApiRecordProperty": {
+ "enum": [
+ "recordIdentity",
+ "recordGuid",
+ "recordHistoryIdentity",
+ "recordHistoryGuid",
+ "tableIdentity",
+ "tableGuid",
+ "tableName",
+ "databaseKey",
+ "createdByUser",
+ "createdDate",
+ "lastModifiedByUser",
+ "lastModifiedDate",
+ "recordType",
+ "versionState",
+ "versionNumber",
+ "releasedDate",
+ "fullName",
+ "shortName",
+ "recordColor"
+ ],
+ "type": "string",
+ "description": "A record property represents data on a record that typically cannot be independently edited,\r\nas opposed to attribute data which may be edited on a record freely (albeit possibly requiring\r\nreleasing a new version). Record properties are usually tracked by the system automatically\r\nand are usually read-only.\r\nNote: for legacy reasons, some 'record properties' do not fall into these criteria, and do\r\nrepresent editable record fields more similar to attribute data. These record properties are\r\nusually exposed in this API as both 'record properties' and 'pseudo-attributes'."
+ },
+ "GrantaServerApiRecordType": {
+ "enum": [
+ "record",
+ "generic",
+ "folder"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the supported record types."
+ },
+ "GrantaServerApiRecordsRecordHistoriesCopyRecordHistory": {
+ "required": [
+ "subsetOption"
+ ],
+ "type": "object",
+ "properties": {
+ "newParent": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesSlimRecordHistory"
+ },
+ "subsetOption": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesRecordPropertyInheritanceType"
+ },
+ "newShortName": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordHistoriesCreateRecordHistory": {
+ "required": [
+ "name",
+ "recordType"
+ ],
+ "type": "object",
+ "properties": {
+ "recordType": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordType"
+ },
+ "name": {
+ "type": "string"
+ },
+ "shortName": {
+ "type": "string",
+ "nullable": true
+ },
+ "parent": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesSlimRecordHistory"
+ },
+ "recordColor": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordColor"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordHistoriesMoveRecordHistory": {
+ "type": "object",
+ "properties": {
+ "newParent": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesSlimRecordHistory"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordHistoriesRecordHistory": {
+ "required": [
+ "guid",
+ "isFolder",
+ "recordVersions",
+ "subsets",
+ "table"
+ ],
+ "type": "object",
+ "properties": {
+ "isFolder": {
+ "type": "boolean"
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimTable"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesSlimRecordHistory"
+ },
+ "recordVersions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordVersionsSlimRecordVersion"
+ }
+ },
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimSubset"
+ }
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordHistoriesRecordPropertyInheritanceType": {
+ "enum": [
+ "none",
+ "fromParent",
+ "fromOriginalRecord"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the possible options for inheriting properties when copying or moving a record history."
+ },
+ "GrantaServerApiRecordsRecordHistoriesSlimRecordHistory": {
+ "required": [
+ "guid"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordVersionsRecordVersion": {
+ "required": [
+ "createdByUser",
+ "createdDate",
+ "databaseKey",
+ "guid",
+ "lastModifiedByUser",
+ "lastModifiedDate",
+ "name",
+ "recordColor",
+ "recordHistory",
+ "recordType",
+ "shortName",
+ "table",
+ "versionNumber",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "recordHistory": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordsRecordHistoriesSlimRecordHistory"
+ },
+ "table": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimTable"
+ },
+ "databaseKey": {
+ "type": "string"
+ },
+ "createdByUser": {
+ "type": "string"
+ },
+ "createdDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedByUser": {
+ "type": "string"
+ },
+ "lastModifiedDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "recordType": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordType"
+ },
+ "releasedDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "shortName": {
+ "type": "string"
+ },
+ "recordColor": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordColor"
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiRecordsRecordVersionsSlimRecordVersion": {
+ "required": [
+ "guid",
+ "name",
+ "versionNumber",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "info": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute+AttributeInfo"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaAttributesPointAttribute\r\n * GrantaServerApiSchemaAttributesIntegerAttribute\r\n * GrantaServerApiSchemaAttributesRangeAttribute\r\n * GrantaServerApiSchemaAttributesLogicalAttribute\r\n * GrantaServerApiSchemaAttributesShortTextAttribute\r\n * GrantaServerApiSchemaAttributesLongTextAttribute\r\n * GrantaServerApiSchemaAttributesDateTimeAttribute\r\n * GrantaServerApiSchemaAttributesDiscreteAttribute\r\n * GrantaServerApiSchemaAttributesHyperlinkAttribute\r\n * GrantaServerApiSchemaAttributesFileAttribute\r\n * GrantaServerApiSchemaAttributesPictureAttribute\r\n * GrantaServerApiSchemaAttributesTabularAttribute\r\n * GrantaServerApiSchemaAttributesFloatFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesDiscreteFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesMathsFunctionalAttribute",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "point": "#/components/schemas/GrantaServerApiSchemaAttributesPointAttribute",
+ "integer": "#/components/schemas/GrantaServerApiSchemaAttributesIntegerAttribute",
+ "range": "#/components/schemas/GrantaServerApiSchemaAttributesRangeAttribute",
+ "logical": "#/components/schemas/GrantaServerApiSchemaAttributesLogicalAttribute",
+ "shortText": "#/components/schemas/GrantaServerApiSchemaAttributesShortTextAttribute",
+ "longText": "#/components/schemas/GrantaServerApiSchemaAttributesLongTextAttribute",
+ "dateTime": "#/components/schemas/GrantaServerApiSchemaAttributesDateTimeAttribute",
+ "discrete": "#/components/schemas/GrantaServerApiSchemaAttributesDiscreteAttribute",
+ "hyperlink": "#/components/schemas/GrantaServerApiSchemaAttributesHyperlinkAttribute",
+ "file": "#/components/schemas/GrantaServerApiSchemaAttributesFileAttribute",
+ "picture": "#/components/schemas/GrantaServerApiSchemaAttributesPictureAttribute",
+ "link": "#/components/schemas/GrantaServerApiSchemaAttributesTabularAttribute",
+ "floatFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesFloatFunctionalAttribute",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesDiscreteFunctionalAttribute",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesMathsFunctionalAttribute"
+ }
+ }
+ },
+ "GrantaServerApiSchemaAttributesAttribute+AttributeInfo": {
+ "required": [
+ "chartable",
+ "expressionable",
+ "extendedName",
+ "foreignDataLinkGroups",
+ "isMetaAttribute",
+ "linkable",
+ "primaryDataLinkGroups",
+ "standardNames",
+ "typeCode"
+ ],
+ "type": "object",
+ "properties": {
+ "typeCode": {
+ "type": "string"
+ },
+ "chartable": {
+ "type": "boolean"
+ },
+ "expressionable": {
+ "type": "boolean"
+ },
+ "linkable": {
+ "type": "boolean"
+ },
+ "extendedName": {
+ "type": "string"
+ },
+ "isMetaAttribute": {
+ "type": "boolean"
+ },
+ "orderedMetaAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "standardNames": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "primaryDataLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "foreignDataLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "primaryDynamicLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "foreignDynamicLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesAttributeInterpolationMethod": {
+ "enum": [
+ "auto",
+ "none",
+ "linear",
+ "cubicSpline"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaAttributesAttributeScaleType": {
+ "enum": [
+ "notSet",
+ "linear",
+ "logarithmic"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaAttributesAttributeThresholdType": {
+ "enum": [
+ "exists",
+ "doesNotExist",
+ "atLeast",
+ "atMost",
+ "equal",
+ "between",
+ "isOneOf",
+ "contains",
+ "isNot",
+ "isAllOf",
+ "none"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaAttributesAttributeValidateResponse": {
+ "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
+ },
+ "GrantaServerApiSchemaAttributesAttributesInfo": {
+ "required": [
+ "attributes"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaAttributesCreateAttributesCreatePointAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateIntegerAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateRangeAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateLogicalAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateShortTextAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateLongTextAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateDateTimeAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateHyperlinkAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateFileAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreatePictureAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateTabularAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesCreateAttributesCreateMathsFunctionalAttribute",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "point": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreatePointAttribute",
+ "integer": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateIntegerAttribute",
+ "range": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateRangeAttribute",
+ "logical": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateLogicalAttribute",
+ "shortText": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateShortTextAttribute",
+ "longText": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateLongTextAttribute",
+ "dateTime": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDateTimeAttribute",
+ "discrete": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteAttribute",
+ "hyperlink": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateHyperlinkAttribute",
+ "file": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateFileAttribute",
+ "picture": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreatePictureAttribute",
+ "link": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateTabularAttribute",
+ "floatFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttribute",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttribute",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateMathsFunctionalAttribute"
+ }
+ }
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDateTimeAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteAttribute": {
+ "required": [
+ "discreteType",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "discreteType",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateDiscreteFunctionalAttributeParameter": {
+ "required": [
+ "parameter"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateFileAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateFloatFunctionalAttributeParameter": {
+ "required": [
+ "parameter"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeScaleType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateHyperlinkAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateIntegerAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateLogicalAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateLongTextAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateMathsFunctionalAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "allowExtrapolation": {
+ "type": "boolean"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreatePictureAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreatePointAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateRangeAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateShortTextAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSchemaAttributesCreateAttributesCreateTabularAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ "nullable": true
+ },
+ "target": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesTabularAttributeTarget"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesCreateAttributesCreateAttribute",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaAttributesDateTimeAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSchemaAttributesDiscreteAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "discreteType",
+ "displayNames",
+ "guid",
+ "info",
+ "isMultiValued",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaAttributesDiscreteFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "defaultThresholdType",
+ "discreteType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiSchemaAttributesDiscreteFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesFileAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSchemaAttributesFloatFunctionalAttribute": {
+ "required": [
+ "attributeParameters",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isRange",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiSchemaAttributesFloatFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeScaleType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesHyperlinkAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSchemaAttributesIntegerAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isUnique",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSchemaAttributesLogicalAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSchemaAttributesLongTextAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSchemaAttributesMathsContent": {
+ "required": [
+ "parameterContents",
+ "transposeAxes",
+ "useLogarithmicScale"
+ ],
+ "type": "object",
+ "properties": {
+ "curveLabel": {
+ "type": "string",
+ "nullable": true
+ },
+ "transposeAxes": {
+ "type": "boolean"
+ },
+ "useLogarithmicScale": {
+ "type": "boolean"
+ },
+ "expression": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimExpression"
+ },
+ "freeParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "parameterContents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterContent"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesMathsFunctionalAttribute": {
+ "required": [
+ "allowAllCompatibleExpressions",
+ "allowAnonymousExpressions",
+ "allowExtrapolation",
+ "attributeParameters",
+ "defaultContent",
+ "defaultThresholdType",
+ "displayNames",
+ "expressions",
+ "guid",
+ "info",
+ "isRange",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimExpression"
+ }
+ },
+ "allowExtrapolation": {
+ "type": "boolean"
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "type": "boolean"
+ },
+ "defaultContent": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesMathsContent"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSchemaAttributesPictureAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSchemaAttributesPointAttribute": {
+ "required": [
+ "attributeParameters",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isMultiValued",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSchemaAttributesRangeAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSchemaAttributesShortTextAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isUnique",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSchemaAttributesTabularAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayFullTable",
+ "displayNames",
+ "displaySummaryRowInline",
+ "guid",
+ "hideUnlinkedRows",
+ "info",
+ "name",
+ "tabularColumns",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesTabularAttributeTarget"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesAttribute",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaAttributesTabularAttributeTarget": {
+ "type": "object",
+ "properties": {
+ "targetDatabaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetDatabaseVersionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetTableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetAttributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdatePointAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateIntegerAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateRangeAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateLogicalAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateShortTextAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateLongTextAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateDateTimeAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateHyperlinkAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateFileAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdatePictureAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateTabularAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttribute\r\n * GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsFunctionalAttribute",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "point": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdatePointAttribute",
+ "integer": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateIntegerAttribute",
+ "range": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateRangeAttribute",
+ "logical": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateLogicalAttribute",
+ "shortText": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateShortTextAttribute",
+ "longText": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateLongTextAttribute",
+ "dateTime": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDateTimeAttribute",
+ "discrete": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteAttribute",
+ "hyperlink": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateHyperlinkAttribute",
+ "file": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateFileAttribute",
+ "picture": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdatePictureAttribute",
+ "link": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateTabularAttribute",
+ "floatFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttribute",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttribute",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsFunctionalAttribute"
+ }
+ }
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDateTimeAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctional"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateDiscreteFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateFileAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateFloatFunctionalAttributeParameter": {
+ "type": "object",
+ "properties": {
+ "parameterGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeScaleType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateHyperlinkAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateIntegerAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateLogicalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateLongTextAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsContent": {
+ "type": "object",
+ "properties": {
+ "curveLabel": {
+ "type": "string",
+ "nullable": true
+ },
+ "transposeAxes": {
+ "type": "boolean"
+ },
+ "useLogarithmicScale": {
+ "type": "boolean"
+ },
+ "expression": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "freeParameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "parameterContents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterContent"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsFunctionalAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "allowExtrapolation": {
+ "type": "boolean"
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "defaultContent": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateMathsContent"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdatePictureAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdatePointAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateRangeAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateShortTextAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ },
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSchemaAttributesUpdateAttributesUpdateTabularAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaAttributesUpdateAttributesUpdateAttribute",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaAttributesValidateAttributeRequest": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The value to check an attributes data validation rules against",
+ "nullable": true
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "description": "The record you want to check the value against to see if the value has changed as well as being valid",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConfigurationsConfiguration": {
+ "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
+ },
+ "GrantaServerApiSchemaConfigurationsConfigurationsInfo": {
+ "required": [
+ "configurations"
+ ],
+ "type": "object",
+ "properties": {
+ "configurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimConfiguration"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConfigurationsCreateConfiguration": {
+ "required": [
+ "name",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConfigurationsUpdateConfiguration": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConstantsConstant": {
+ "required": [
+ "guid",
+ "name",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Constant used in equations"
+ },
+ "GrantaServerApiSchemaConstantsConstantsInfo": {
+ "type": "object",
+ "properties": {
+ "constants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimConstant"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaConstantsCreateConstant": {
+ "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
+ },
+ "GrantaServerApiSchemaConstantsUpdateConstant": {
+ "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
+ },
+ "GrantaServerApiSchemaDataRulesCreateDataRule": {
+ "required": [
+ "description",
+ "name",
+ "regularExpression"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDataRulesDataRule": {
+ "required": [
+ "description",
+ "guid",
+ "name",
+ "regularExpression",
+ "usedByAttributes"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "usedByAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDataRulesDataRulesInfo": {
+ "type": "object",
+ "properties": {
+ "dataRules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDataRulesDataRule"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDataRulesUpdateDataRule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDatabase": {
+ "required": [
+ "isLocked",
+ "isReadOnly",
+ "key",
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "string",
+ "nullable": true
+ },
+ "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/GrantaServerApiDatabaseStatus"
+ },
+ "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
+ },
+ "GrantaServerApiSchemaDatabasesInfo": {
+ "type": "object",
+ "properties": {
+ "databases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimDatabase"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesCreateDiscreteType": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesDiscreteType": {
+ "required": [
+ "guid",
+ "isOrdered",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesDiscreteTypesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteTypesDiscreteType"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteTypesUpdateDiscreteType": {
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue": {
+ "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"
+ },
+ "GrantaServerApiSchemaDiscreteValuesDiscreteValue": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesDiscreteValuesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesDiscreteValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesReplaceDiscreteValuesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaDiscreteValuesCreateDiscreteValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaDiscreteValuesUpdateDiscreteValue": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsCreateExpression": {
+ "required": [
+ "name",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsExpression": {
+ "required": [
+ "attributeDependencies",
+ "constantDependencies",
+ "guid",
+ "name",
+ "parameterDependencies",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "attributeDependencies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "constantDependencies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "parameterDependencies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsExpressionsInfo": {
+ "type": "object",
+ "properties": {
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimExpression"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaExpressionsUpdateExpression": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesCreateFolder": {
+ "required": [
+ "name",
+ "parentGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "parentGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesExporterRefetchInfo": {
+ "type": "object",
+ "properties": {
+ "succeeded": {
+ "type": "boolean"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFileHeader": {
+ "required": [
+ "dataLength",
+ "description",
+ "extension",
+ "folderGuid",
+ "guid",
+ "name",
+ "path"
+ ],
+ "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"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFilesInfo": {
+ "type": "object",
+ "properties": {
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimFile"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFolder": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "parentGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesFoldersInfo": {
+ "type": "object",
+ "properties": {
+ "folders": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaFilesFolder"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesMoveFile": {
+ "required": [
+ "folderGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "folderGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesMoveFolder": {
+ "required": [
+ "parentGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "parentGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesUpdateFile": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaFilesUpdateFolder": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsCreateLayout": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Layouts\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "GrantaServerApiSchemaLayoutsCreateLayoutSection": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Layout Sections\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "GrantaServerApiSchemaLayoutsFullLayoutSection": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sectionDetailType",
+ "sectionItems"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sectionDetailType": {
+ "type": "string",
+ "default": "full"
+ },
+ "sectionItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItem"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutSection",
+ "x-discriminator-value": "full"
+ },
+ "GrantaServerApiSchemaLayoutsLayout": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sections"
+ ],
+ "type": "object",
+ "properties": {
+ "sections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsLayoutAttributeItem": {
+ "required": [
+ "attributeType",
+ "guid",
+ "itemType",
+ "name",
+ "readOnly",
+ "required",
+ "underlyingEntityGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "attribute"
+ },
+ "attributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "required": {
+ "type": "boolean"
+ },
+ "readOnly": {
+ "type": "boolean"
+ },
+ "metaAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutAttributeItem"
+ },
+ "nullable": true
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutTabularColumn"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutItem",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSchemaLayoutsLayoutItem": {
+ "required": [
+ "guid",
+ "itemType",
+ "name",
+ "underlyingEntityGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "underlyingEntityGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaLayoutsLayoutAttributeItem\r\n * GrantaServerApiSchemaLayoutsLayoutLinkItem",
+ "discriminator": {
+ "propertyName": "itemType",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutAttributeItem",
+ "link": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutLinkItem"
+ }
+ }
+ },
+ "GrantaServerApiSchemaLayoutsLayoutItemLinkType": {
+ "enum": [
+ "recordLink",
+ "smartLink",
+ "crossDatabaseLink",
+ "associationChain"
+ ],
+ "type": "string",
+ "description": "The types of layout items that represent links to another table."
+ },
+ "GrantaServerApiSchemaLayoutsLayoutItemType": {
+ "enum": [
+ "attribute",
+ "link"
+ ],
+ "type": "string",
+ "description": "The types of layout item that are supported by the API."
+ },
+ "GrantaServerApiSchemaLayoutsLayoutLinkItem": {
+ "required": [
+ "forwards",
+ "guid",
+ "itemType",
+ "linkType",
+ "name",
+ "targetTable",
+ "underlyingEntityGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "link"
+ },
+ "linkType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutItemLinkType"
+ },
+ "targetDatabase": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "targetDatabaseVersion": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "targetTable": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "forwards": {
+ "type": "boolean"
+ },
+ "nextLink": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutLinkItem"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutItem",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSchemaLayoutsLayoutSection": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sectionDetailType"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaSlimEntitiesSlimLayoutSection\r\n * GrantaServerApiSchemaLayoutsFullLayoutSection",
+ "discriminator": {
+ "propertyName": "sectionDetailType",
+ "mapping": {
+ "slim": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayoutSection",
+ "full": "#/components/schemas/GrantaServerApiSchemaLayoutsFullLayoutSection"
+ }
+ }
+ },
+ "GrantaServerApiSchemaLayoutsLayoutSectionDetailType": {
+ "enum": [
+ "slim",
+ "full"
+ ],
+ "type": "string",
+ "description": "The types of detail returned for a layout section."
+ },
+ "GrantaServerApiSchemaLayoutsLayoutSectionsInfo": {
+ "type": "object",
+ "properties": {
+ "layoutSections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsLayoutTabularColumn": {
+ "required": [
+ "columnType",
+ "guid",
+ "name",
+ "tabularColumnGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnDtoType"
+ },
+ "tabularColumnGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsLayoutsInfo": {
+ "type": "object",
+ "properties": {
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutAssociationChainItem": {
+ "required": [
+ "associationChainLinks",
+ "associationChainName",
+ "itemType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "associationChain"
+ },
+ "associationChainName": {
+ "type": "string"
+ },
+ "associationChainLinks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAssociationChainLink"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "associationChain"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutAssociationChainLink": {
+ "required": [
+ "sourceDatabaseVersionGuid",
+ "tabularAttributeGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "forwards": {
+ "type": "boolean"
+ },
+ "sourceDatabaseVersionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "tabularAttributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutAttributeItem": {
+ "required": [
+ "attributeGuid",
+ "itemType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "attribute"
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": {
+ "type": "boolean"
+ },
+ "readOnly": {
+ "type": "boolean"
+ },
+ "metaAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAttributeItem"
+ },
+ "nullable": true
+ },
+ "tabularColumnGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutCrossDatabaseLinkItem": {
+ "required": [
+ "itemType",
+ "linkGroupGuid",
+ "sourceDatabaseGuid",
+ "sourceTableGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "crossDatabaseLink"
+ },
+ "sourceDatabaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "sourceTableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "linkGroupGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "crossDatabaseLink"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutItem": {
+ "required": [
+ "itemType"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaLayoutsNewLayoutAttributeItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutRecordLinkItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutSmartLinkItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutCrossDatabaseLinkItem\r\n * GrantaServerApiSchemaLayoutsNewLayoutAssociationChainItem",
+ "discriminator": {
+ "propertyName": "itemType",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAttributeItem",
+ "recordLink": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutRecordLinkItem",
+ "smartLink": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutSmartLinkItem",
+ "crossDatabaseLink": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutCrossDatabaseLinkItem",
+ "associationChain": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutAssociationChainItem"
+ }
+ }
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutItemType": {
+ "enum": [
+ "attribute",
+ "recordLink",
+ "smartLink",
+ "crossDatabaseLink",
+ "associationChain"
+ ],
+ "type": "string",
+ "description": "The types of new layout item that are supported by the API."
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutRecordLinkItem": {
+ "required": [
+ "itemType",
+ "linkGroupGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "recordLink"
+ },
+ "linkGroupGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "recordLink"
+ },
+ "GrantaServerApiSchemaLayoutsNewLayoutSmartLinkItem": {
+ "required": [
+ "itemType",
+ "linkGroupGuid"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsNewLayoutItem"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "default": "smartLink"
+ },
+ "forwards": {
+ "type": "boolean"
+ },
+ "linkGroupGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsNewLayoutItem",
+ "x-discriminator-value": "smartLink"
+ },
+ "GrantaServerApiSchemaLayoutsReorderSectionsInfo": {
+ "required": [
+ "layoutSections"
+ ],
+ "type": "object",
+ "properties": {
+ "layoutSections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaLayoutsUpdateLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersContinuousRange": {
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersCreateDiscreteParameter": {
+ "required": [
+ "defaultParameterValueIndex",
+ "name",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateDiscreteParameterValue"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameter",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersCreateDiscreteParameterValue": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameterValue",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersCreateNumericParameter": {
+ "required": [
+ "defaultParameterValueIndex",
+ "interpolationType",
+ "isRestricted",
+ "name",
+ "scaleType",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "isRestricted": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateNumericParameterValue"
+ }
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameter",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersCreateNumericParameterValue": {
+ "required": [
+ "type",
+ "value"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersCreateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersCreateParameterValue",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersCreateParameter": {
+ "required": [
+ "defaultParameterValueIndex",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "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 * GrantaServerApiSchemaParametersCreateDiscreteParameter\r\n * GrantaServerApiSchemaParametersCreateNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersCreateDiscreteParameter",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersCreateNumericParameter"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersCreateParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersCreateDiscreteParameterValue\r\n * GrantaServerApiSchemaParametersCreateNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersCreateDiscreteParameterValue",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersCreateNumericParameterValue"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersDiscreteParameter": {
+ "required": [
+ "defaultParameterValueGuid",
+ "displayNames",
+ "guid",
+ "name",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameterValue"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameter",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersDiscreteParameterContent": {
+ "required": [
+ "parameter",
+ "parameterRange",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "parameterValue": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterContent",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersDiscreteParameterValue": {
+ "required": [
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterValue",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersDiscreteRange": {
+ "required": [
+ "parameterValues"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersNumericParameter": {
+ "required": [
+ "defaultParameterValueGuid",
+ "displayNames",
+ "guid",
+ "interpolationType",
+ "isRestricted",
+ "name",
+ "scaleType",
+ "type",
+ "values"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "isRestricted": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameterValue"
+ }
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameter",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersNumericParameterContent": {
+ "required": [
+ "parameter",
+ "parameterRange",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "value": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersContinuousRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterContent",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersNumericParameterValue": {
+ "required": [
+ "guid",
+ "type",
+ "value"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersParameterValue",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersParameter": {
+ "required": [
+ "defaultParameterValueGuid",
+ "displayNames",
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "defaultParameterValueGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersDiscreteParameter\r\n * GrantaServerApiSchemaParametersNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameter",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameter"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersDiscreteParameterContent\r\n * GrantaServerApiSchemaParametersNumericParameterContent",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameterContent",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameterContent"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersParameterInterpolationType": {
+ "enum": [
+ "none",
+ "linear",
+ "cubicSpline"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParameterScaleType": {
+ "enum": [
+ "linear",
+ "logarithmic"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParameterType": {
+ "enum": [
+ "discrete",
+ "numeric"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParameterValue": {
+ "required": [
+ "guid",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersDiscreteParameterValue\r\n * GrantaServerApiSchemaParametersNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersDiscreteParameterValue",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersNumericParameterValue"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersParameterValueType": {
+ "enum": [
+ "discrete",
+ "numeric"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaParametersParametersInfo": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameter"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersUpdateContinuousRange": {
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteParameter": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameter",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "parameterValue": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterContent",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterValue",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSchemaParametersUpdateDiscreteRange": {
+ "required": [
+ "parameterValues"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaParametersUpdateNumericParameter": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameter",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersUpdateNumericParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "value": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateContinuousRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterContent",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersUpdateNumericParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaParametersUpdateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaParametersUpdateParameterValue",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSchemaParametersUpdateParameter": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "defaultParameterValueGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersUpdateDiscreteParameter\r\n * GrantaServerApiSchemaParametersUpdateNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteParameter",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersUpdateNumericParameter"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersUpdateParameterContent": {
+ "required": [
+ "parameter",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersUpdateDiscreteParameterContent\r\n * GrantaServerApiSchemaParametersUpdateNumericParameterContent",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteParameterContent",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersUpdateNumericParameterContent"
+ }
+ }
+ },
+ "GrantaServerApiSchemaParametersUpdateParameterValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaParametersUpdateDiscreteParameterValue\r\n * GrantaServerApiSchemaParametersUpdateNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GrantaServerApiSchemaParametersUpdateDiscreteParameterValue",
+ "numeric": "#/components/schemas/GrantaServerApiSchemaParametersUpdateNumericParameterValue"
+ }
+ }
+ },
+ "GrantaServerApiSchemaProfileTablesCreateProfileTable": {
+ "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
+ },
+ "GrantaServerApiSchemaProfileTablesProfileTable": {
+ "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."
+ },
+ "GrantaServerApiSchemaProfileTablesProfileTablesInfo": {
+ "type": "object",
+ "properties": {
+ "profileTables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimProfileTable"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaProfileTablesUpdateProfileTable": {
+ "type": "object",
+ "properties": {
+ "subsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "layoutGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A table within a profile. Contains display customization."
+ },
+ "GrantaServerApiSchemaProfilesAllProfilesInfo": {
+ "type": "object",
+ "properties": {
+ "profiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimProfile"
+ },
+ "nullable": true
+ },
+ "defaultProfile": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimProfile"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiSchemaProfilesCreateProfile": {
+ "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
+ },
+ "GrantaServerApiSchemaProfilesProfile": {
+ "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/GrantaServerApiSchemaSlimEntitiesSlimProfileTable"
+ }
+ },
+ "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."
+ },
+ "GrantaServerApiSchemaProfilesUpdateAllProfilesInfo": {
+ "type": "object",
+ "properties": {
+ "profiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "defaultProfile": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaProfilesUpdateDefaultProfile"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Used to update the list of all profiles as well as default profile."
+ },
+ "GrantaServerApiSchemaProfilesUpdateDefaultProfile": {
+ "required": [
+ "key"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key is a unique identifier of a profile. Separate from guid."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaProfilesUpdateProfile": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "homepageUrl": {
+ "type": "string",
+ "nullable": true
+ },
+ "profileTableGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "description": "Guid is a unique identifier of a profile. Separate from key.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "groupName": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A profile, consisting of a set of tables from one or more databases."
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsAttributeLinkPair": {
+ "type": "object",
+ "properties": {
+ "attributeSource": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ },
+ "attributeTarget": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateAttributeLinkPair": {
+ "required": [
+ "attributeSourceGuid",
+ "attributeTargetGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "attributeSourceGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "attributeTargetGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateCrossDatabaseRecordLinkGroup": {
+ "required": [
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "crossDatabase"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup",
+ "x-discriminator-value": "crossDatabase"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateDynamicRecordLinkGroup": {
+ "required": [
+ "attributePairs",
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dynamic"
+ },
+ "forbidOrphans": {
+ "type": "boolean"
+ },
+ "referentialIntegrityModel": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel"
+ },
+ "attributePairs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateAttributeLinkPair"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup",
+ "x-discriminator-value": "dynamic"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup": {
+ "required": [
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "linkTarget": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkTarget"
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaRecordLinkGroupsCreateStaticRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsCreateDynamicRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsCreateCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCreateStaticRecordLinkGroup": {
+ "required": [
+ "linkTarget",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "static"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsCreateRecordLinkGroup",
+ "x-discriminator-value": "static"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsCrossDatabaseRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "includeIndirectLinks",
+ "linkInfo",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "crossDatabase"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup",
+ "x-discriminator-value": "crossDatabase"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsDynamicRecordLinkGroup": {
+ "required": [
+ "attributePairs",
+ "displayNames",
+ "forbidOrphans",
+ "guid",
+ "linkInfo",
+ "name",
+ "referentialIntegrityModel",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dynamic"
+ },
+ "forbidOrphans": {
+ "type": "boolean"
+ },
+ "referentialIntegrityModel": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel"
+ },
+ "attributePairs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsAttributeLinkPair"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup",
+ "x-discriminator-value": "dynamic"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsLinkInfo": {
+ "required": [
+ "linkSource",
+ "linkTarget"
+ ],
+ "type": "object",
+ "properties": {
+ "linkSource": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkTarget"
+ },
+ "linkTarget": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkTarget"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsLinkTarget": {
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "databaseVersionGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "linkInfo",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "linkInfo": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsLinkInfo"
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "reverseDisplayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaRecordLinkGroupsStaticRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsDynamicRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupType": {
+ "enum": [
+ "static",
+ "dynamic",
+ "crossDatabase"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupsInfo": {
+ "type": "object",
+ "properties": {
+ "recordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimRecordLinkGroup"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel": {
+ "enum": [
+ "oneToOne",
+ "oneToMany",
+ "manyToMany"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsStaticRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "includeIndirectLinks",
+ "linkInfo",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "static"
+ },
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroup",
+ "x-discriminator-value": "static"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateCrossDatabaseRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "crossDatabase"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup",
+ "x-discriminator-value": "crossDatabase"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateDynamicRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "forbidOrphans": {
+ "type": "boolean"
+ },
+ "referentialIntegrityModel": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsReferentialIntegrityModel"
+ },
+ "attributePairs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsCreateAttributeLinkPair"
+ }
+ },
+ "type": {
+ "type": "string",
+ "default": "dynamic"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup",
+ "x-discriminator-value": "dynamic"
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "reverseName": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaRecordLinkGroupsUpdateStaticRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsUpdateDynamicRecordLinkGroup\r\n * GrantaServerApiSchemaRecordLinkGroupsUpdateCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GrantaServerApiSchemaRecordLinkGroupsUpdateStaticRecordLinkGroup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "static"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaRecordLinkGroupsUpdateRecordLinkGroup",
+ "x-discriminator-value": "static"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimAttribute": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimConfiguration": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimConstant": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "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"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimDatabase": {
+ "required": [
+ "isLocked",
+ "isReadOnly",
+ "key",
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "status": {
+ "$ref": "#/components/schemas/GrantaServerApiDatabaseStatus"
+ },
+ "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
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimEntity": {
+ "required": [
+ "guid"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimExpression": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimFile": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimLayout": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimLayoutSection": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sectionDetailType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaLayoutsLayoutSection"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sectionDetailType": {
+ "type": "string",
+ "default": "slim"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaLayoutsLayoutSection",
+ "x-discriminator-value": "slim"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimNamedEntity": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimObjects": {
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimProfile": {
+ "required": [
+ "isImplicit",
+ "key",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "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": "Profile stripped down to only the basic fields"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimProfileTable": {
+ "required": [
+ "databaseGuid",
+ "tableGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "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": "Profile table stripped to just the basic fields"
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaRecordLinkGroupsRecordLinkGroupType"
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "reverseDisplayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimSubset": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimTable": {
+ "required": [
+ "displayNames",
+ "guid",
+ "isHiddenFromBrowse",
+ "isHiddenFromSearch",
+ "isVersioned",
+ "name",
+ "tableTypes"
+ ],
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "isVersioned": {
+ "type": "boolean"
+ },
+ "tableTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimUnit": {
+ "required": [
+ "guid",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSlimEntitiesSlimUnitSystem": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Unit system stripped down to its basic fields (mappings excluded)."
+ },
+ "GrantaServerApiSchemaStandardNamesCreateStandardName": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedCrossDatabaseRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaStandardNamesStandardName": {
+ "required": [
+ "guid",
+ "mappedAttributes",
+ "mappedCrossDatabaseRecordLinkGroups",
+ "mappedParameters",
+ "mappedRecordLinkGroups",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "mappedRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "mappedCrossDatabaseRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaStandardNamesStandardNamesInfo": {
+ "type": "object",
+ "properties": {
+ "standardNames": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaStandardNamesStandardName"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaStandardNamesUpdateStandardName": {
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedCrossDatabaseRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsAddRecordHistoryToSubset": {
+ "required": [
+ "recordHistoryGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recurseChildren": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsCreateSubset": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsRemoveRecordHistoryFromSubset": {
+ "required": [
+ "recordHistoryGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsSubset": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsSubsetsInfo": {
+ "type": "object",
+ "properties": {
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimSubset"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaSubsetsUpdateSubset": {
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesCreateTable": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesTable": {
+ "required": [
+ "displayNames",
+ "guid",
+ "isHiddenFromBrowse",
+ "isHiddenFromSearch",
+ "isVersioned",
+ "layouts",
+ "name",
+ "subsets",
+ "tableTypes",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultSubset": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimSubset"
+ },
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimSubset"
+ }
+ },
+ "defaultLayout": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ },
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimLayout"
+ }
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GrantaServerApiVersionState"
+ },
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "isVersioned": {
+ "type": "boolean"
+ },
+ "tableTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesTablesInfo": {
+ "type": "object",
+ "properties": {
+ "tables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimTable"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTablesUpdateTable": {
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "defaultSubsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "defaultLayoutGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedAttributeTabularColumn": {
+ "required": [
+ "columnType",
+ "linkedAttribute",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedAttribute"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "linkedAttribute"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedColumnTabularColumn": {
+ "required": [
+ "columnType",
+ "linkedColumn",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedColumn"
+ },
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "linkedColumn"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedRecordTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedRecord"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "linkedRecord"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDateTimeTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDateTime"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localDateTime"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDiscreteTabularColumn": {
+ "required": [
+ "columnType",
+ "discreteType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDiscrete"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localDiscrete"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalFileTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localFile"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localFile"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalHyperlinkTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localHyperlink"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localHyperlink"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalIntegerTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localInteger"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localInteger"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLogicalTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLogical"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localLogical"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLongTextTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLongText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localLongText"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPictureTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPicture"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localPicture"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPointTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPoint"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localPoint"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalRangeTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localRange"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localRange"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalShortTextTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localShortText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn",
+ "x-discriminator-value": "localShortText"
+ },
+ "GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateTabularColumn": {
+ "required": [
+ "columnType",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "showAsLink": {
+ "type": "boolean"
+ },
+ "summaryRowEnabled": {
+ "type": "boolean"
+ },
+ "summaryRowText": {
+ "type": "string",
+ "nullable": true
+ },
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRowRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedAttributeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedColumnTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedRecordTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPointTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalRangeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalIntegerTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLogicalTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalShortTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLongTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDateTimeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDiscreteTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalHyperlinkTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalFileTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPictureTabularColumn",
+ "discriminator": {
+ "propertyName": "columnType",
+ "mapping": {
+ "linkedAttribute": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GrantaServerApiSchemaTabularColumnsCreateTabularColumnsCreateLocalPictureTabularColumn"
+ }
+ }
+ },
+ "GrantaServerApiSchemaTabularColumnsLinkedAttributeTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "linkedAttribute",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedAttribute"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "linkedAttribute"
+ },
+ "GrantaServerApiSchemaTabularColumnsLinkedColumnTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "linkedAttribute",
+ "linkedColumn",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedColumn"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimAttribute"
+ },
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "linkedColumn"
+ },
+ "GrantaServerApiSchemaTabularColumnsLinkedRecordTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedRecord"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "linkedRecord"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalDateTimeTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDateTime"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localDateTime"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalDiscreteTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "discreteType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDiscrete"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localDiscrete"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalFileTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localFile"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localFile"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalHyperlinkTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localHyperlink"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localHyperlink"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalIntegerTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localInteger"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localInteger"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalLogicalTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLogical"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localLogical"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalLongTextTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLongText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localLongText"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalPictureTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPicture"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localPicture"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalPointTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPoint"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localPoint"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalRangeTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localRange"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localRange"
+ },
+ "GrantaServerApiSchemaTabularColumnsLocalShortTextTabularColumn": {
+ "required": [
+ "columnType",
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localShortText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "localShortText"
+ },
+ "GrantaServerApiSchemaTabularColumnsTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "properties": {
+ "showAsLink": {
+ "type": "boolean"
+ },
+ "summaryRowEnabled": {
+ "type": "boolean"
+ },
+ "summaryRowText": {
+ "type": "string"
+ },
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRowRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaTabularColumnsLinkedAttributeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLinkedColumnTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLinkedRecordTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalPointTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalRangeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalIntegerTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalLogicalTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalShortTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalLongTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalDateTimeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalDiscreteTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalHyperlinkTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalFileTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsLocalPictureTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUnavailableTabularColumn",
+ "discriminator": {
+ "propertyName": "columnType",
+ "mapping": {
+ "linkedAttribute": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GrantaServerApiSchemaTabularColumnsLocalPictureTabularColumn",
+ "unavailable": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUnavailableTabularColumn"
+ }
+ }
+ },
+ "GrantaServerApiSchemaTabularColumnsTabularColumnDtoType": {
+ "enum": [
+ "linkedAttribute",
+ "linkedRecord",
+ "linkedColumn",
+ "localInteger",
+ "localPoint",
+ "localRange",
+ "localLogical",
+ "localShortText",
+ "localLongText",
+ "localDateTime",
+ "localDiscrete",
+ "localHyperlink",
+ "localFile",
+ "localPicture",
+ "unavailable"
+ ],
+ "type": "string",
+ "description": "The types of tabular column."
+ },
+ "GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType": {
+ "enum": [
+ "list",
+ "max",
+ "min",
+ "mean",
+ "stdDev",
+ "sum",
+ "count",
+ "countDistinct",
+ "listDistinct",
+ "coefficientOfVariation",
+ "chart"
+ ],
+ "type": "string",
+ "description": "The roll up types of a tabular column."
+ },
+ "GrantaServerApiSchemaTabularColumnsUnavailableTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "unavailable"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsTabularColumn",
+ "x-discriminator-value": "unavailable"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedAttributeTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedAttribute"
+ },
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "linkedAttribute"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedColumnTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedColumn"
+ },
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "linkedColumn"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedRecordTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "linkedRecord"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "linkedRecord"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDateTimeTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDateTime"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localDateTime"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDiscreteTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localDiscrete"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localDiscrete"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalFileTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localFile"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localFile"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalHyperlinkTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localHyperlink"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localHyperlink"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalIntegerTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localInteger"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localInteger"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLogicalTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLogical"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localLogical"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLongTextTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localLongText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localLongText"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPictureTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPicture"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localPicture"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPointTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localPoint"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localPoint"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalRangeTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localRange"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localRange"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalShortTextTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "type": "string",
+ "default": "localShortText"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaAttributesAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn",
+ "x-discriminator-value": "localShortText"
+ },
+ "GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "type": "object",
+ "properties": {
+ "showAsLink": {
+ "type": "boolean"
+ },
+ "summaryRowEnabled": {
+ "type": "boolean"
+ },
+ "summaryRowText": {
+ "type": "string",
+ "nullable": true
+ },
+ "rollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "summaryRowRollUpType": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaTabularColumnsTabularColumnRollUpType"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedAttributeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedColumnTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedRecordTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPointTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalRangeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalIntegerTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLogicalTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalShortTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLongTextTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDateTimeTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDiscreteTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalHyperlinkTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalFileTabularColumn\r\n * GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPictureTabularColumn",
+ "discriminator": {
+ "propertyName": "columnType",
+ "mapping": {
+ "linkedAttribute": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GrantaServerApiSchemaTabularColumnsUpdateTabularColumnsUpdateLocalPictureTabularColumn"
+ }
+ }
+ },
+ "GrantaServerApiSchemaUnitsCreateUnit": {
+ "required": [
+ "name",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsCreateUnitSystem": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Unit Systems\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "GrantaServerApiSchemaUnitsUnit": {
+ "required": [
+ "guid",
+ "name",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "symbol": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitEquivalent": {
+ "required": [
+ "equivalentUnit",
+ "unit",
+ "unitSystem"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ },
+ "unitSystem": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitSystem"
+ },
+ "equivalentUnit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitEquivalentsInfo": {
+ "type": "object",
+ "properties": {
+ "unitEquivalents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitEquivalent"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitMapping": {
+ "required": [
+ "equivalentUnit",
+ "unit"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "equivalentUnit": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitSystem": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "unitMappings"
+ ],
+ "type": "object",
+ "properties": {
+ "unitMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaUnitsUnitMapping"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Unit system contains mappings from any unit to equivalent unit within this unit system.\r\nIf some unit comes from particular unit system it will be mapped to itself."
+ },
+ "GrantaServerApiSchemaUnitsUnitSystemsInfo": {
+ "type": "object",
+ "properties": {
+ "unitSystems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnitSystem"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitUsage": {
+ "required": [
+ "attributes",
+ "constants",
+ "expressions",
+ "parameters",
+ "units"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "constants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimNamedEntity"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUnitsInfo": {
+ "type": "object",
+ "properties": {
+ "units": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSchemaSlimEntitiesSlimUnit"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUpdateUnit": {
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUnitsUpdateUnitSystem": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSchemaUpdateDatabase": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "string",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "currencyCode": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchAttributeCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "isMetaAttribute": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Base class for attribute criterions. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GrantaServerApiSearchCriterion\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchAttributeMatchesCriterion\r\n * GrantaServerApiSearchAttributeExistsCriterion\r\n * GrantaServerApiSearchAttributeNotApplicableCriterion",
+ "discriminator": {
+ "propertyName": "attributeCriterionType",
+ "mapping": {
+ "matches": "#/components/schemas/GrantaServerApiSearchAttributeMatchesCriterion",
+ "exists": "#/components/schemas/GrantaServerApiSearchAttributeExistsCriterion",
+ "notApplicable": "#/components/schemas/GrantaServerApiSearchAttributeNotApplicableCriterion"
+ }
+ },
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSearchAttributeExistsCriterion": {
+ "required": [
+ "attributeCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchAttributeCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ "attributeCriterionType": {
+ "type": "string",
+ "default": "exists"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchAttributeCriterion",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiSearchAttributeMatchesCriterion": {
+ "required": [
+ "attributeCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchAttributeCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ "attributeCriterionType": {
+ "type": "string",
+ "default": "matches"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchAttributeCriterion",
+ "x-discriminator-value": "matches"
+ },
+ "GrantaServerApiSearchAttributeNotApplicableCriterion": {
+ "required": [
+ "attributeCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchAttributeCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeCriterionType": {
+ "type": "string",
+ "default": "notApplicable"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchAttributeCriterion",
+ "x-discriminator-value": "notApplicable"
+ },
+ "GrantaServerApiSearchAttributeSortCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "attributeType": {
+ "$ref": "#/components/schemas/GrantaServerApiAttributeType"
+ },
+ "sortType": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortType"
+ },
+ "type": {
+ "type": "string",
+ "default": "attribute"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiSearchSortCriterion",
+ "x-discriminator-value": "attribute"
+ },
+ "GrantaServerApiSearchBooleanCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "description": "Only records that match all of these criteria are returned.",
+ "nullable": true
+ },
+ "any": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "description": "Only results that match any of these criteria are returned.",
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "description": "Only results that match none of these criteria are returned.",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "boolean"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "boolean"
+ },
+ "GrantaServerApiSearchBoostByGuid": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "boostFactor": {
+ "type": "number",
+ "format": "double",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchBoostByIdentity": {
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "boostFactor": {
+ "type": "number",
+ "format": "double",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiSearchBooleanCriterion\r\n * GrantaServerApiSearchFreeTextCriterion\r\n * GrantaServerApiSearchRecordListMemberCriterion\r\n * GrantaServerApiSearchRecordPropertyCriterion\r\n * GrantaServerApiSearchRecordReferenceCriterion\r\n * GrantaServerApiSearchRecordAncestorCriterion\r\n * GrantaServerApiSearchRecordAncestorHistoryIdentitiesCriterion\r\n * GrantaServerApiSearchRecordSubsetCriterion\r\n * GrantaServerApiSearchTabularLinkingValueCriterion\r\n * GrantaServerApiSearchAttributeCriterion\r\n * GrantaServerApiSearchLocalColumnCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "boolean": "#/components/schemas/GrantaServerApiSearchBooleanCriterion",
+ "text": "#/components/schemas/GrantaServerApiSearchFreeTextCriterion",
+ "recordListMember": "#/components/schemas/GrantaServerApiSearchRecordListMemberCriterion",
+ "recordProperty": "#/components/schemas/GrantaServerApiSearchRecordPropertyCriterion",
+ "reference": "#/components/schemas/GrantaServerApiSearchRecordReferenceCriterion",
+ "recordAncestor": "#/components/schemas/GrantaServerApiSearchRecordAncestorCriterion",
+ "recordAncestorIdentities": "#/components/schemas/GrantaServerApiSearchRecordAncestorHistoryIdentitiesCriterion",
+ "subset": "#/components/schemas/GrantaServerApiSearchRecordSubsetCriterion",
+ "tabularLinkingValue": "#/components/schemas/GrantaServerApiSearchTabularLinkingValueCriterion",
+ "attribute": "#/components/schemas/GrantaServerApiSearchAttributeCriterion",
+ "localColumn": "#/components/schemas/GrantaServerApiSearchLocalColumnCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchDateTimeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSearchDateTimeDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "dateTime"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "dateTime"
+ },
+ "GrantaServerApiSearchDatumCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiSearchDateTimeDatumCriterion\r\n * GrantaServerApiSearchDiscreteFunctionalRangeDatumCriterion\r\n * GrantaServerApiSearchDiscreteFunctionalValuesDatumCriterion\r\n * GrantaServerApiSearchDiscreteIdentityDatumCriterion\r\n * GrantaServerApiSearchDiscreteIdentityValuesDatumCriterion\r\n * GrantaServerApiSearchDiscreteGuidDatumCriterion\r\n * GrantaServerApiSearchDiscreteGuidValuesDatumCriterion\r\n * GrantaServerApiSearchDiscreteRangeDatumCriterion\r\n * GrantaServerApiSearchDiscreteTextDatumCriterion\r\n * GrantaServerApiSearchDiscreteTextValuesDatumCriterion\r\n * GrantaServerApiSearchFileDatumCriterion\r\n * GrantaServerApiSearchFloatFunctionalDatumCriterion\r\n * GrantaServerApiSearchFloatFunctionalGraphDatumCriterion\r\n * GrantaServerApiSearchHyperlinkDatumCriterion\r\n * GrantaServerApiSearchIntegerDatumCriterion\r\n * GrantaServerApiSearchLinkDatumCriterion\r\n * GrantaServerApiSearchLogicalDatumCriterion\r\n * GrantaServerApiSearchLongTextDatumCriterion\r\n * GrantaServerApiSearchMathsFunctionalDatumCriterion\r\n * GrantaServerApiSearchPictureDatumCriterion\r\n * GrantaServerApiSearchPointDatumCriterion\r\n * GrantaServerApiSearchRangeDatumCriterion\r\n * GrantaServerApiSearchShortTextDatumCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "dateTime": "#/components/schemas/GrantaServerApiSearchDateTimeDatumCriterion",
+ "discreteFunctionalRange": "#/components/schemas/GrantaServerApiSearchDiscreteFunctionalRangeDatumCriterion",
+ "discreteFunctionalValues": "#/components/schemas/GrantaServerApiSearchDiscreteFunctionalValuesDatumCriterion",
+ "discreteIdentity": "#/components/schemas/GrantaServerApiSearchDiscreteIdentityDatumCriterion",
+ "discreteIdentityValues": "#/components/schemas/GrantaServerApiSearchDiscreteIdentityValuesDatumCriterion",
+ "discreteGuid": "#/components/schemas/GrantaServerApiSearchDiscreteGuidDatumCriterion",
+ "discreteGuidValues": "#/components/schemas/GrantaServerApiSearchDiscreteGuidValuesDatumCriterion",
+ "discreteRange": "#/components/schemas/GrantaServerApiSearchDiscreteRangeDatumCriterion",
+ "discreteText": "#/components/schemas/GrantaServerApiSearchDiscreteTextDatumCriterion",
+ "discreteTextValues": "#/components/schemas/GrantaServerApiSearchDiscreteTextValuesDatumCriterion",
+ "file": "#/components/schemas/GrantaServerApiSearchFileDatumCriterion",
+ "floatFunctionalData": "#/components/schemas/GrantaServerApiSearchFloatFunctionalDatumCriterion",
+ "floatFunctionalGraph": "#/components/schemas/GrantaServerApiSearchFloatFunctionalGraphDatumCriterion",
+ "hyperlink": "#/components/schemas/GrantaServerApiSearchHyperlinkDatumCriterion",
+ "integer": "#/components/schemas/GrantaServerApiSearchIntegerDatumCriterion",
+ "link": "#/components/schemas/GrantaServerApiSearchLinkDatumCriterion",
+ "logical": "#/components/schemas/GrantaServerApiSearchLogicalDatumCriterion",
+ "longText": "#/components/schemas/GrantaServerApiSearchLongTextDatumCriterion",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSearchMathsFunctionalDatumCriterion",
+ "picture": "#/components/schemas/GrantaServerApiSearchPictureDatumCriterion",
+ "point": "#/components/schemas/GrantaServerApiSearchPointDatumCriterion",
+ "range": "#/components/schemas/GrantaServerApiSearchRangeDatumCriterion",
+ "shortText": "#/components/schemas/GrantaServerApiSearchShortTextDatumCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchDatumExistsCriterion": {
+ "type": "object",
+ "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 * GrantaServerApiSearchIntegerDatumExistsCriterion\r\n * GrantaServerApiSearchPointDatumExistsCriterion\r\n * GrantaServerApiSearchRangeDatumExistsCriterion\r\n * GrantaServerApiSearchLogicalDatumExistsCriterion\r\n * GrantaServerApiSearchShortTextDatumExistsCriterion\r\n * GrantaServerApiSearchLongTextDatumExistsCriterion\r\n * GrantaServerApiSearchDateTimeDatumExistsCriterion\r\n * GrantaServerApiSearchDiscreteDatumExistsCriterion\r\n * GrantaServerApiSearchHyperlinkDatumExistsCriterion\r\n * GrantaServerApiSearchFileDatumExistsCriterion\r\n * GrantaServerApiSearchPictureDatumExistsCriterion\r\n * GrantaServerApiSearchLinkExistsDatumCriterion\r\n * GrantaServerApiSearchFloatFunctionalDatumExistsCriterion\r\n * GrantaServerApiSearchDiscreteFunctionalDatumExistsCriterion\r\n * GrantaServerApiSearchMathsFunctionalDatumExistsCriterion\r\n * GrantaServerApiSearchTabularDatumExistsCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "integer": "#/components/schemas/GrantaServerApiSearchIntegerDatumExistsCriterion",
+ "point": "#/components/schemas/GrantaServerApiSearchPointDatumExistsCriterion",
+ "range": "#/components/schemas/GrantaServerApiSearchRangeDatumExistsCriterion",
+ "logical": "#/components/schemas/GrantaServerApiSearchLogicalDatumExistsCriterion",
+ "shortText": "#/components/schemas/GrantaServerApiSearchShortTextDatumExistsCriterion",
+ "longText": "#/components/schemas/GrantaServerApiSearchLongTextDatumExistsCriterion",
+ "dateTime": "#/components/schemas/GrantaServerApiSearchDateTimeDatumExistsCriterion",
+ "discrete": "#/components/schemas/GrantaServerApiSearchDiscreteDatumExistsCriterion",
+ "hyperlink": "#/components/schemas/GrantaServerApiSearchHyperlinkDatumExistsCriterion",
+ "file": "#/components/schemas/GrantaServerApiSearchFileDatumExistsCriterion",
+ "picture": "#/components/schemas/GrantaServerApiSearchPictureDatumExistsCriterion",
+ "link": "#/components/schemas/GrantaServerApiSearchLinkExistsDatumCriterion",
+ "floatFunctional": "#/components/schemas/GrantaServerApiSearchFloatFunctionalDatumExistsCriterion",
+ "discreteFunctional": "#/components/schemas/GrantaServerApiSearchDiscreteFunctionalDatumExistsCriterion",
+ "mathsFunctional": "#/components/schemas/GrantaServerApiSearchMathsFunctionalDatumExistsCriterion",
+ "tabular": "#/components/schemas/GrantaServerApiSearchTabularDatumExistsCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchDiscreteDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discrete"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "discrete"
+ },
+ "GrantaServerApiSearchDiscreteFunctionalDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctional"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "discreteFunctional"
+ },
+ "GrantaServerApiSearchDiscreteFunctionalRangeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "discreteFunctionalRange"
+ },
+ "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/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Optional unit string. If not included, the gte and lte values are assumed to be in database units.",
+ "nullable": true,
+ "readOnly": 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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteFunctionalRange"
+ },
+ "GrantaServerApiSearchDiscreteFunctionalValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteFunctionalValues"
+ },
+ "constraints": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.",
+ "nullable": true,
+ "readOnly": true
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteFunctionalValues"
+ },
+ "GrantaServerApiSearchDiscreteGuidDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteGuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "discreteGuid: Criterion for matching records where the GUID of the discrete data matches the specified value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteGuid"
+ },
+ "GrantaServerApiSearchDiscreteGuidValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteGuidValues"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteGuidValues"
+ },
+ "GrantaServerApiSearchDiscreteIdentityDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteIdentity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "discreteIdentity: Criterion for matching records where the identity of the discrete data matches the specified value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteIdentity"
+ },
+ "GrantaServerApiSearchDiscreteIdentityValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteIdentityValues"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteIdentityValues"
+ },
+ "GrantaServerApiSearchDiscreteParameterNameConstraint": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "any": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteName"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchParameterConstraint",
+ "x-discriminator-value": "discreteName"
+ },
+ "GrantaServerApiSearchDiscreteParameterValueConstraint": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "any": {
+ "type": "array",
+ "items": {
+ "type": "number",
+ "format": "double"
+ },
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "type": "number",
+ "format": "double"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchParameterConstraint",
+ "x-discriminator-value": "discreteValue"
+ },
+ "GrantaServerApiSearchDiscreteRangeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "discreteRange"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteRange"
+ },
+ "GrantaServerApiSearchDiscreteTextDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "textMatchBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchTextMatchBehavior"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "discreteText: Criterion for matching records where the text of the discrete data contains the specified value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteText"
+ },
+ "GrantaServerApiSearchDiscreteTextValuesDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "any": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "textMatchBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchTextMatchBehavior"
+ },
+ "type": {
+ "type": "string",
+ "default": "discreteTextValues"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "discreteTextValues"
+ },
+ "GrantaServerApiSearchDoubleSortingValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "type": {
+ "type": "string",
+ "default": "double"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchSortingValue",
+ "x-discriminator-value": "double"
+ },
+ "GrantaServerApiSearchFileDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSearchFileDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "file"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "file"
+ },
+ "GrantaServerApiSearchFloatFunctionalDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctionalData"
+ },
+ "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/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.",
+ "nullable": true,
+ "readOnly": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "floatFunctionalData: Criterion for matching records with float functional data\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "floatFunctionalData"
+ },
+ "GrantaServerApiSearchFloatFunctionalDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctional"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "floatFunctional"
+ },
+ "GrantaServerApiSearchFloatFunctionalGraphDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "floatFunctionalGraph"
+ },
+ "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": "floatFunctionalGraph: Criterion for matching records with float functional data\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "floatFunctionalGraph"
+ },
+ "GrantaServerApiSearchFreeTextCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "attributes": {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ "localColumns": {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ "attributeIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "attributeGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "columnIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "columnGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchBoostByGuid"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Base type for free text criteria.\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiSearchHyperlinkDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "hyperlink: Criterion for matching records where the hyperlink description contains the given value.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSearchHyperlinkDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "hyperlink"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "hyperlink"
+ },
+ "GrantaServerApiSearchIndexStatus": {
+ "type": "object",
+ "properties": {
+ "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,
+ "readOnly": 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
+ },
+ "diskStatus": {
+ "$ref": "#/components/schemas/GrantaServerApiDiskStatus"
+ },
+ "diskThreshold": {
+ "type": "string",
+ "description": "The 'flood stage' threshold from Elasticsearch.",
+ "nullable": true
+ },
+ "searchIndexUnavailable": {
+ "type": "boolean",
+ "description": "True if the index could not be contacted.",
+ "nullable": true
+ },
+ "recordsThatFailedToIndex": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiIndexRecordFailure"
+ },
+ "description": "Details of any records that failed to index.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchIntegerDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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": {
+ "type": "string",
+ "default": "integer"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSearchIntegerDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "integer"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "integer"
+ },
+ "GrantaServerApiSearchLinkDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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/GrantaServerApiSearchCriterion"
+ },
+ "linkDatumType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "indirectLinks": {
+ "$ref": "#/components/schemas/GrantaServerApiIndirectLinks"
+ },
+ "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/GrantaServerApiSearchCriterion"
+ },
+ "type": {
+ "type": "string",
+ "default": "link"
+ },
+ "localRowsBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLocalRowsBehavior"
+ }
+ }
+ }
+ ],
+ "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\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSearchLinkExistsDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "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",
+ "nullable": true
+ },
+ "linkDatumType": {
+ "$ref": "#/components/schemas/GrantaServerApiLinkAttributeType"
+ },
+ "indirectLinks": {
+ "$ref": "#/components/schemas/GrantaServerApiIndirectLinks"
+ },
+ "searchInReversedDirection": {
+ "type": "boolean"
+ },
+ "localRowsBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLocalRowsBehavior"
+ },
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "link"
+ }
+ }
+ }
+ ],
+ "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\nThis extends: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "link"
+ },
+ "GrantaServerApiSearchLinkingValueMatchBehavior": {
+ "enum": [
+ "AllRows",
+ "VisibleRows",
+ "ExactMatchMatchingRows",
+ "FreeTextMatchingRows"
+ ],
+ "type": "string",
+ "description": "Enum for use in the Granta.Server.Api.Search.TabularLinkingValueCriterion to control which tabular rows are returnedPossible 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"
+ },
+ "GrantaServerApiSearchLocalColumnCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "localColumn"
+ }
+ },
+ "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: GrantaServerApiSearchCriterion\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchLocalColumnMatchesCriterion\r\n * GrantaServerApiSearchLocalColumnExistsCriterion\r\n * GrantaServerApiSearchLocalColumnNotApplicableCriterion",
+ "discriminator": {
+ "propertyName": "localColumnCriterionType",
+ "mapping": {
+ "matches": "#/components/schemas/GrantaServerApiSearchLocalColumnMatchesCriterion",
+ "exists": "#/components/schemas/GrantaServerApiSearchLocalColumnExistsCriterion",
+ "notApplicable": "#/components/schemas/GrantaServerApiSearchLocalColumnNotApplicableCriterion"
+ }
+ },
+ "x-discriminator-value": "localColumn"
+ },
+ "GrantaServerApiSearchLocalColumnExistsCriterion": {
+ "required": [
+ "innerCriterion",
+ "localColumnCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLocalColumnCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ "localColumnCriterionType": {
+ "type": "string",
+ "default": "exists"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchLocalColumnCriterion",
+ "x-discriminator-value": "exists"
+ },
+ "GrantaServerApiSearchLocalColumnMatchesCriterion": {
+ "required": [
+ "innerCriterion",
+ "localColumnCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLocalColumnCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ "localColumnCriterionType": {
+ "type": "string",
+ "default": "matches"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchLocalColumnCriterion",
+ "x-discriminator-value": "matches"
+ },
+ "GrantaServerApiSearchLocalColumnNotApplicableCriterion": {
+ "required": [
+ "localColumnCriterionType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLocalColumnCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localColumnCriterionType": {
+ "type": "string",
+ "default": "notApplicable"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchLocalColumnCriterion",
+ "x-discriminator-value": "notApplicable"
+ },
+ "GrantaServerApiSearchLocalRowsBehavior": {
+ "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"
+ },
+ "GrantaServerApiSearchLogicalDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean",
+ "description": "Logical search value"
+ },
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSearchLogicalDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "logical"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "logical"
+ },
+ "GrantaServerApiSearchLongSortingValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "type": {
+ "type": "string",
+ "default": "long"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchSortingValue",
+ "x-discriminator-value": "long"
+ },
+ "GrantaServerApiSearchLongTextDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Long text search value",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSearchLongTextDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "longText"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "longText"
+ },
+ "GrantaServerApiSearchMathsFunctionalDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ },
+ "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/GrantaServerApiSearchParameterConstraint"
+ },
+ "description": "Constraints on the parameters of the attribute. Unspecified parameters will be assumed to be unconstrained.",
+ "nullable": true,
+ "readOnly": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "mathsFunctional: Criterion for matching records with maths functional data (EELs)\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSearchMathsFunctionalDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "mathsFunctional"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "mathsFunctional"
+ },
+ "GrantaServerApiSearchNumericParameterConstraint": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchParameterConstraint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "gte": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "lte": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "scaleType": {
+ "type": "string",
+ "description": "Optionally, override the scale type of the parameter. Can be Linear or Log",
+ "nullable": true
+ },
+ "interpolationType": {
+ "type": "string",
+ "description": "Optionally, override the interpolation type of the parameter. Can be Auto, None, Linear or CubicSpline",
+ "nullable": true
+ },
+ "significantFigures": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "numeric"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchParameterConstraint",
+ "x-discriminator-value": "numeric"
+ },
+ "GrantaServerApiSearchPagingOptions": {
+ "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,
+ "readOnly": 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"
+ },
+ "GrantaServerApiSearchParameterConstraint": {
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GrantaServerApiObjectIdentifier"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchDiscreteParameterNameConstraint\r\n * GrantaServerApiSearchDiscreteParameterValueConstraint\r\n * GrantaServerApiSearchNumericParameterConstraint",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discreteName": "#/components/schemas/GrantaServerApiSearchDiscreteParameterNameConstraint",
+ "discreteValue": "#/components/schemas/GrantaServerApiSearchDiscreteParameterValueConstraint",
+ "numeric": "#/components/schemas/GrantaServerApiSearchNumericParameterConstraint"
+ }
+ }
+ },
+ "GrantaServerApiSearchPictureDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "picture: Criterion for matching records where picture data exists.\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSearchPictureDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "picture"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "picture"
+ },
+ "GrantaServerApiSearchPointDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "gte": {
+ "type": "number",
+ "description": "Greater than or equal",
+ "format": "double",
+ "nullable": true
+ },
+ "lte": {
+ "type": "number",
+ "description": "Less than or equal",
+ "format": "double",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "point"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSearchPointDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "point"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "point"
+ },
+ "GrantaServerApiSearchRangeDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "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
+ },
+ "type": {
+ "type": "string",
+ "default": "range"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSearchRangeDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "range"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "range"
+ },
+ "GrantaServerApiSearchRecordAncestorCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ancestorIdentity": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "directParentOnly": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordAncestor"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor identity is provided, returns records that sit directly below the table\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordAncestor"
+ },
+ "GrantaServerApiSearchRecordAncestorHistoryIdentitiesCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ancestorHistoryIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordAncestorIdentities"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records whose ancestors include one of the specified record history identities\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordAncestorIdentities"
+ },
+ "GrantaServerApiSearchRecordListMemberCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordListIdentifiers": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "recordListMember"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records contained within at least one of the referenced record lists.\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordListMember"
+ },
+ "GrantaServerApiSearchRecordPropertyCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchableRecordProperty"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ "type": {
+ "type": "string",
+ "default": "recordProperty"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion for a search matching values in a given record property.\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "recordProperty"
+ },
+ "GrantaServerApiSearchRecordPropertySortCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchableRecordProperty"
+ },
+ "sortType": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortType"
+ },
+ "type": {
+ "type": "string",
+ "default": "recordProperty"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Specifies a record property based sort criterion for a search query.\r\n\r\nThis extends: GrantaServerApiSearchSortCriterion",
+ "x-discriminator-value": "recordProperty"
+ },
+ "GrantaServerApiSearchRecordReferenceCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "reference"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records matching a specific reference. The database key must be provided, along with either the record GUID or the record identity.\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "reference"
+ },
+ "GrantaServerApiSearchRecordSubsetCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "subsetIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "subsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "subset"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "subset"
+ },
+ "GrantaServerApiSearchRelevanceSortCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "relevance"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Specifies a relevance based sort criterion for a search query\r\n\r\nThis extends: GrantaServerApiSearchSortCriterion",
+ "x-discriminator-value": "relevance"
+ },
+ "GrantaServerApiSearchSearchRequest": {
+ "type": "object",
+ "properties": {
+ "criterion": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ "sortCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortCriterion"
+ },
+ "description": "An optional set of attribute based sort criteria. If none are provided, the results will be sorted in descending relevance order.",
+ "nullable": true
+ },
+ "pagingOptions": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchPagingOptions"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchResponse": {
+ "type": "object",
+ "properties": {
+ "searchIdentifier": {
+ "type": "string",
+ "description": "If the search request had paging options specified, this will return an identifier that can be used to get the rest of the results",
+ "format": "uuid",
+ "nullable": true
+ },
+ "totalResultCount": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSearchResult"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchResult": {
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordName": {
+ "type": "string",
+ "nullable": true
+ },
+ "treeName": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordColor": {
+ "type": "string",
+ "nullable": true
+ },
+ "tableIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "cubicSplineStatus": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionControlState": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "parentIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GrantaServerApiRecordType"
+ },
+ "score": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "sortingValue": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchResultsRequest": {
+ "type": "object",
+ "properties": {
+ "pageNumber": {
+ "type": "integer",
+ "description": "The (1-indexed) number of the page to return from a search\r\nThe size of the page was determined by the original query",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSearchSearchableRecordProperty": {
+ "enum": [
+ "createdDate",
+ "creator",
+ "lastModifiedDate",
+ "lastModifier",
+ "recordType",
+ "color",
+ "versionState",
+ "versionNumber",
+ "recordName",
+ "treeName",
+ "databaseKey",
+ "tableName",
+ "tableIdentity"
+ ],
+ "type": "string",
+ "description": "Properties of a record that can be used to in searchesPossible 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
\r\n"
+ },
+ "GrantaServerApiSearchShortTextDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "textMatchBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchTextMatchBehavior"
+ },
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchDatumCriterion",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSearchShortTextDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "shortText"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "shortText"
+ },
+ "GrantaServerApiSearchSortCriterion": {
+ "type": "object",
+ "properties": {
+ "sortDirection": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortDirection"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchAttributeSortCriterion\r\n * GrantaServerApiSearchRecordPropertySortCriterion\r\n * GrantaServerApiSearchRelevanceSortCriterion",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "attribute": "#/components/schemas/GrantaServerApiSearchAttributeSortCriterion",
+ "recordProperty": "#/components/schemas/GrantaServerApiSearchRecordPropertySortCriterion",
+ "relevance": "#/components/schemas/GrantaServerApiSearchRelevanceSortCriterion"
+ }
+ }
+ },
+ "GrantaServerApiSearchSortDirection": {
+ "enum": [
+ "ascending",
+ "descending"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSearchSortType": {
+ "enum": [
+ "natural",
+ "alphabetical"
+ ],
+ "type": "string",
+ "description": "For a text-type sort, whether the results should use a pure alphabetical or a natural sort (where multi-digit numbers within strings are treated as a single character for the purposes of sorting)."
+ },
+ "GrantaServerApiSearchSortingValue": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GrantaServerApiSearchDoubleSortingValue\r\n * GrantaServerApiSearchLongSortingValue\r\n * GrantaServerApiSearchStringSortingValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "double": "#/components/schemas/GrantaServerApiSearchDoubleSortingValue",
+ "long": "#/components/schemas/GrantaServerApiSearchLongSortingValue",
+ "text": "#/components/schemas/GrantaServerApiSearchStringSortingValue"
+ }
+ }
+ },
+ "GrantaServerApiSearchStringSortingValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "default": "text"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchSortingValue",
+ "x-discriminator-value": "text"
+ },
+ "GrantaServerApiSearchTabularDatumExistsCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchDatumExistsCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "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: GrantaServerApiSearchDatumExistsCriterion",
+ "x-discriminator-value": "tabular"
+ },
+ "GrantaServerApiSearchTabularLinkingValueCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiSearchCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "linkingValueMatchBehavior": {
+ "$ref": "#/components/schemas/GrantaServerApiSearchLinkingValueMatchBehavior"
+ },
+ "type": {
+ "type": "string",
+ "default": "tabularLinkingValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GrantaServerApiSearchCriterion",
+ "x-discriminator-value": "tabularLinkingValue"
+ },
+ "GrantaServerApiSearchTextMatchBehavior": {
+ "enum": [
+ "contains",
+ "exactMatch",
+ "exactMatchCaseInsensitive"
+ ],
+ "type": "string"
+ },
+ "GrantaServerApiSelectionSearchesCreateSearchRequest": {
+ "type": "object",
+ "properties": {
+ "searchConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "detail": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSearchDetail"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesFindSearchRequest": {
+ "type": "object",
+ "properties": {
+ "nameContains": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesSaveSearchRequest": {
+ "type": "object",
+ "properties": {
+ "searchConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "detail": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesSearchDetail"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesSearchDetail": {
+ "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
+ },
+ "GrantaServerApiSelectionSearchesSelectionSearch": {
+ "type": "object",
+ "properties": {
+ "searchIdentifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "currentUserAccessInfo": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ },
+ "nullable": true
+ },
+ "criteria": {
+ "type": "string",
+ "nullable": true
+ },
+ "exploreConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdUserOrGroup": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesUserOrGroup"
+ },
+ "lastModifiedTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedUserOrGroup": {
+ "$ref": "#/components/schemas/GrantaServerApiSelectionSearchesUserOrGroup"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSelectionSearchesUserOrGroup": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayName": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GrantaServerApiSpecificValuesSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GrantaServerApiValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "guids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "filterOn": {
+ "type": "string",
+ "default": "specific"
+ }
+ }
+ }
+ ],
+ "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: GrantaServerApiValueSpecifier",
+ "x-discriminator-value": "specific"
+ },
+ "GrantaServerApiValueSpecifier": {
+ "type": "object",
+ "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 * GrantaServerApiAllValuesSpecifier\r\n * GrantaServerApiExcludeValuesSpecifier\r\n * GrantaServerApiSpecificValuesSpecifier\r\n * GrantaServerApiNoValuesSpecifier",
+ "discriminator": {
+ "propertyName": "filterOn",
+ "mapping": {
+ "all": "#/components/schemas/GrantaServerApiAllValuesSpecifier",
+ "exclude": "#/components/schemas/GrantaServerApiExcludeValuesSpecifier",
+ "specific": "#/components/schemas/GrantaServerApiSpecificValuesSpecifier",
+ "none": "#/components/schemas/GrantaServerApiNoValuesSpecifier"
+ }
+ }
+ },
+ "GrantaServerApiValueSpecifierType": {
+ "enum": [
+ "all",
+ "exclude",
+ "specific",
+ "none"
+ ],
+ "type": "string",
+ "description": "Types of ValueSpecifier allowed in requests.\r\nUsed by ValueSpecifier to specify whether we want all identities, some guids, exclude some identities, etc."
+ },
+ "GrantaServerApiVersionState": {
+ "enum": [
+ "unversioned",
+ "unreleased",
+ "released",
+ "superseded",
+ "withdrawn"
+ ],
+ "type": "string",
+ "description": "API-level enum for version control state."
+ },
+ "JsonPatchDocument": {
+ "type": "object",
+ "properties": {
+ "op": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "MicrosoftAspNetCoreMvcFormattersIOutputFormatter": {
+ "type": "object",
+ "additionalProperties": false
+ },
+ "MicrosoftAspNetCoreMvcObjectResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "object",
+ "nullable": true
+ },
+ "formatters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcFormattersIOutputFormatter"
+ },
+ "nullable": true
+ },
+ "contentTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "declaredType": {
+ "type": "string",
+ "nullable": true
+ },
+ "statusCode": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "SystemNetHttpStatusCode": {
+ "enum": [
+ 100,
+ 101,
+ 200,
+ 201,
+ 202,
+ 203,
+ 204,
+ 205,
+ 206,
+ 300,
+ 301,
+ 302,
+ 303,
+ 304,
+ 305,
+ 306,
+ 307,
+ 400,
+ 401,
+ 402,
+ 403,
+ 404,
+ 405,
+ 406,
+ 407,
+ 408,
+ 409,
+ 410,
+ 411,
+ 412,
+ 413,
+ 414,
+ 415,
+ 416,
+ 417,
+ 426,
+ 500,
+ 501,
+ 502,
+ 503,
+ 504,
+ 505
+ ],
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/yaml/server-api-25r1.json b/yaml/server-api-25r1.json
new file mode 100644
index 00000000..39460153
--- /dev/null
+++ b/yaml/server-api-25r1.json
@@ -0,0 +1,50028 @@
+{
+ "openapi": "3.0.1",
+ "info": {
+ "title": "MI Server API",
+ "version": "v1"
+ },
+ "paths": {
+ "/v1alpha/databases/{database-key}/tables/{table-identity}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the table.",
+ "operationId": "DatabaseAggregationForTableWithIdentity",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "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/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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 34": {
+ "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"}]}
+ },
+ "Example 35": {
+ "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"}]}
+ },
+ "Example 36": {
+ "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 37": {
+ "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":"791774b9-41d9-4f3d-afe0-8036445368c7","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"25070d1b-6355-4dbd-8bd1-3a12517b8797","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"7b4a5e02-a1d0-4d22-a9cb-81b9fa7ee574","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 40": {
+ "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"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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 34": {
+ "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"}]}
+ },
+ "Example 35": {
+ "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"}]}
+ },
+ "Example 36": {
+ "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 37": {
+ "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":"791774b9-41d9-4f3d-afe0-8036445368c7","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"25070d1b-6355-4dbd-8bd1-3a12517b8797","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"7b4a5e02-a1d0-4d22-a9cb-81b9fa7ee574","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 40": {
+ "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"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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 34": {
+ "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"}]}
+ },
+ "Example 35": {
+ "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"}]}
+ },
+ "Example 36": {
+ "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 37": {
+ "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":"791774b9-41d9-4f3d-afe0-8036445368c7","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"25070d1b-6355-4dbd-8bd1-3a12517b8797","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"7b4a5e02-a1d0-4d22-a9cb-81b9fa7ee574","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 40": {
+ "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"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 33": {
+ "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 34": {
+ "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"}]}
+ },
+ "Example 35": {
+ "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"}]}
+ },
+ "Example 36": {
+ "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 37": {
+ "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":"791774b9-41d9-4f3d-afe0-8036445368c7","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 38": {
+ "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":"25070d1b-6355-4dbd-8bd1-3a12517b8797","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 39": {
+ "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":"7b4a5e02-a1d0-4d22-a9cb-81b9fa7ee574","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 40": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the table.",
+ "operationId": "DatabaseAggregationForTableWithGuid",
+ "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/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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 42": {
+ "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"}]}
+ },
+ "Example 43": {
+ "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"}]}
+ },
+ "Example 44": {
+ "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 45": {
+ "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":"a52e439e-ed0f-4746-b1b7-33a0549dde3a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"490808c7-6016-4e2d-a2b1-e19e16ed1c3e","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ddec1b25-e5f0-4730-b9b0-55aef014aa07","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 48": {
+ "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"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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 42": {
+ "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"}]}
+ },
+ "Example 43": {
+ "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"}]}
+ },
+ "Example 44": {
+ "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 45": {
+ "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":"a52e439e-ed0f-4746-b1b7-33a0549dde3a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"490808c7-6016-4e2d-a2b1-e19e16ed1c3e","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ddec1b25-e5f0-4730-b9b0-55aef014aa07","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 48": {
+ "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"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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 42": {
+ "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"}]}
+ },
+ "Example 43": {
+ "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"}]}
+ },
+ "Example 44": {
+ "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 45": {
+ "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":"a52e439e-ed0f-4746-b1b7-33a0549dde3a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"490808c7-6016-4e2d-a2b1-e19e16ed1c3e","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ddec1b25-e5f0-4730-b9b0-55aef014aa07","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 48": {
+ "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"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 41": {
+ "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 42": {
+ "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"}]}
+ },
+ "Example 43": {
+ "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"}]}
+ },
+ "Example 44": {
+ "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 45": {
+ "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":"a52e439e-ed0f-4746-b1b7-33a0549dde3a","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 46": {
+ "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":"490808c7-6016-4e2d-a2b1-e19e16ed1c3e","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 47": {
+ "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":"ddec1b25-e5f0-4730-b9b0-55aef014aa07","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 48": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the database.",
+ "operationId": "DatabaseAggregation",
+ "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/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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 50": {
+ "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"}]}
+ },
+ "Example 51": {
+ "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"}]}
+ },
+ "Example 52": {
+ "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 53": {
+ "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":"df371bd1-882e-4e7c-8dff-562132686b02","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"65b00698-881c-44c5-a147-464d663885b1","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"7cb4b6b3-29bb-4cbb-86bb-13ec4b16c7b2","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 56": {
+ "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"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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 50": {
+ "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"}]}
+ },
+ "Example 51": {
+ "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"}]}
+ },
+ "Example 52": {
+ "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 53": {
+ "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":"df371bd1-882e-4e7c-8dff-562132686b02","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"65b00698-881c-44c5-a147-464d663885b1","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"7cb4b6b3-29bb-4cbb-86bb-13ec4b16c7b2","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 56": {
+ "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"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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 50": {
+ "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"}]}
+ },
+ "Example 51": {
+ "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"}]}
+ },
+ "Example 52": {
+ "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 53": {
+ "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":"df371bd1-882e-4e7c-8dff-562132686b02","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"65b00698-881c-44c5-a147-464d663885b1","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"7cb4b6b3-29bb-4cbb-86bb-13ec4b16c7b2","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 56": {
+ "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"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 49": {
+ "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 50": {
+ "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"}]}
+ },
+ "Example 51": {
+ "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"}]}
+ },
+ "Example 52": {
+ "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 53": {
+ "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":"df371bd1-882e-4e7c-8dff-562132686b02","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 54": {
+ "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":"65b00698-881c-44c5-a147-464d663885b1","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 55": {
+ "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":"7cb4b6b3-29bb-4cbb-86bb-13ec4b16c7b2","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 56": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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 not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:aggregations": {
+ "post": {
+ "tags": [
+ "Aggregation"
+ ],
+ "summary": "Runs an aggregation against the integration schema.",
+ "operationId": "IntegrationAggregation",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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 58": {
+ "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"}]}
+ },
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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 61": {
+ "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":"dd9c9a23-d06f-4120-ab61-1a49677f81b5","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"0210f141-5b8c-4b5c-8d48-03b90d498321","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"85904ff8-4d2e-41f8-a84d-7d450ba4e2ae","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 64": {
+ "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"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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 58": {
+ "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"}]}
+ },
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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 61": {
+ "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":"dd9c9a23-d06f-4120-ab61-1a49677f81b5","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"0210f141-5b8c-4b5c-8d48-03b90d498321","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"85904ff8-4d2e-41f8-a84d-7d450ba4e2ae","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 64": {
+ "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"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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 58": {
+ "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"}]}
+ },
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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 61": {
+ "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":"dd9c9a23-d06f-4120-ab61-1a49677f81b5","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"0210f141-5b8c-4b5c-8d48-03b90d498321","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"85904ff8-4d2e-41f8-a84d-7d450ba4e2ae","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 64": {
+ "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"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsRequest"
+ },
+ "examples": {
+ "Example 57": {
+ "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 58": {
+ "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"}]}
+ },
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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 61": {
+ "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":"dd9c9a23-d06f-4120-ab61-1a49677f81b5","numberOfTerms":10,"prefix":"st","attributes":{"filterOn":"all"},"localColumns":{"filterOn":"all"},"type":"text"}]}
+ },
+ "Example 62": {
+ "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":"0210f141-5b8c-4b5c-8d48-03b90d498321","numberOfTerms":10,"prefix":"st","attributes":{"identities":[-4,-7,10907],"guids":[],"filterOn":"specific"},"localColumns":{"filterOn":"none"},"type":"text"}]}
+ },
+ "Example 63": {
+ "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":"85904ff8-4d2e-41f8-a84d-7d450ba4e2ae","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 64": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAggregationsResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema 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",
+ "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": "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"
+ },
+ "examples": {
+ "Example 41": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 42": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 43": {
+ "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 44": {
+ "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 45": {
+ "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 46": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "examples": {
+ "Example 51": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 52": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 53": {
+ "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 54": {
+ "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 55": {
+ "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 56": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 57": {
+ "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 58": {
+ "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 59": {
+ "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 60": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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}": {
+ "get": {
+ "tags": [
+ "Data"
+ ],
+ "summary": "Get a datum for a given database, record history, record version and attribute.",
+ "operationId": "GetDatumForVersion",
+ "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": "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"
+ },
+ "examples": {
+ "Example 61": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 62": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 63": {
+ "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 64": {
+ "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 65": {
+ "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 66": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 67": {
+ "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 68": {
+ "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 69": {
+ "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 70": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "examples": {
+ "Example 71": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 72": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 73": {
+ "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 74": {
+ "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 75": {
+ "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 76": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "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",
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Attribute is not an exportable type"
+ },
+ "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}:export": {
+ "get": {
+ "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",
+ "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": "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": "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"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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"
+ },
+ "examples": {
+ "Example 11": {
+ "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 12": {
+ "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"
+ },
+ "examples": {
+ "Example 13": {
+ "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 14": {
+ "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, 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"
+ },
+ "examples": {
+ "Example 15": {
+ "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 16": {
+ "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, 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"
+ }
+ },
+ "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",
+ "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, 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",
+ "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"
+ }
+ },
+ {
+ "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 29": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 30": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 29": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 30": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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"
+ },
+ "examples": {
+ "Example 29": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 30": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 29": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 30": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDatum"
+ },
+ "examples": {
+ "Example 41": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 42": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 43": {
+ "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 44": {
+ "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 45": {
+ "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 46": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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."
+ }
+ }
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table, record history, attribute or datum not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/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.",
+ "operationId": "SetDatumForAttribute",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ "examples": {
+ "Example 43": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 44": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 45": {
+ "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 46": {
+ "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 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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 51": {
+ "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 52": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 53": {
+ "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 54": {
+ "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 55": {
+ "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 56": {
+ "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 43": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 44": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 45": {
+ "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 46": {
+ "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 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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 51": {
+ "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 52": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 53": {
+ "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 54": {
+ "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 55": {
+ "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 56": {
+ "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"
+ },
+ "examples": {
+ "Example 43": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 44": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 45": {
+ "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 46": {
+ "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 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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 51": {
+ "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 52": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 53": {
+ "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 54": {
+ "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 55": {
+ "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 56": {
+ "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 43": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 44": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 45": {
+ "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 46": {
+ "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 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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 51": {
+ "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 52": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3479018-05:00"}
+ },
+ "Example 53": {
+ "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 54": {
+ "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 55": {
+ "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 56": {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDatum"
+ },
+ "examples": {
+ "Example 51": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 52": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 53": {
+ "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 54": {
+ "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 55": {
+ "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 56": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 57": {
+ "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 58": {
+ "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 59": {
+ "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 60": {
+ "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, 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.",
+ "operationId": "DeleteDatumForAttribute",
+ "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"
+ }
+ }
+ ],
+ "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": "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ "examples": {
+ "Example 19": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 20": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 21": {
+ "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 22": {
+ "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 23": {
+ "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 24": {
+ "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 25": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 26": {
+ "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 27": {
+ "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 19": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 20": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 21": {
+ "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 22": {
+ "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 23": {
+ "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 24": {
+ "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 25": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 26": {
+ "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 27": {
+ "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 19": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 20": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 21": {
+ "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 22": {
+ "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 23": {
+ "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 24": {
+ "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 25": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 26": {
+ "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 27": {
+ "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 19": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 20": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 21": {
+ "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 22": {
+ "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 23": {
+ "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 24": {
+ "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 25": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 26": {
+ "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 27": {
+ "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 61": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 62": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 63": {
+ "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 64": {
+ "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 65": {
+ "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 66": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 67": {
+ "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 68": {
+ "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 69": {
+ "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 70": {
+ "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, 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",
+ "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"
+ }
+ }
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ "examples": {
+ "Example 28": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 29": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 35": {
+ "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 36": {
+ "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 28": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 29": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 35": {
+ "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 36": {
+ "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 28": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 29": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 35": {
+ "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 36": {
+ "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 28": {
+ "summary": "Integer datum",
+ "description": "This example demonstrates how to set the value for an integer cell datum.",
+ "value": {"setDatumType":"integer","value":34}
+ },
+ "Example 29": {
+ "summary": "Logical datum",
+ "description": "This example demonstrates how to set the value for a logical cell datum.",
+ "value": {"setDatumType":"logical","value":true}
+ },
+ "Example 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "summary": "DateTime datum",
+ "description": "This example demonstrates how to set the value for a DateTime cell datum.",
+ "value": {"setDatumType":"datetime","value":"2025-03-03T13:32:40.3635262-05:00"}
+ },
+ "Example 35": {
+ "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 36": {
+ "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 71": {
+ "summary": "Integer datum.",
+ "description": "Example response for an integer datum with a value of 7.",
+ "value": {"datumType":"integer","value":7,"notApplicable":"applicable"}
+ },
+ "Example 72": {
+ "summary": "Logical datum.",
+ "description": "Example response for a logical datum with a value of 'true'",
+ "value": {"datumType":"logical","value":true,"notApplicable":"applicable"}
+ },
+ "Example 73": {
+ "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 74": {
+ "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 75": {
+ "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 76": {
+ "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-05:00","notApplicable":"applicable"}
+ },
+ "Example 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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, 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",
+ "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"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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/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",
+ "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"
+ }
+ }
+ ],
+ "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/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",
+ "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": {
+ "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"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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": {
+ "tags": [
+ "Data"
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "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/GsaFileDatum"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table, record history, tabular attribute, row or column not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/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.",
+ "operationId": "SetCellFileDatumForTabularAttribute",
+ "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"
+ }
+ }
+ ],
+ "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/GsaFileDatum"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, record history, tabular attribute, row or column 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": {
+ "tags": [
+ "Data"
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "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}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": {
+ "put": {
+ "tags": [
+ "Data"
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, record history, tabular attribute, row or column not found"
+ },
+ "415": {
+ "description": "Invalid image file"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": {
+ "post": {
+ "tags": [
+ "Data"
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "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}:set-not-applicable": {
+ "post": {
+ "tags": [
+ "Data"
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "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",
+ "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/GsaAppendDiscreteValues"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 5": {
+ "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 6": {
+ "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 5": {
+ "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 6": {
+ "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 5": {
+ "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 6": {
+ "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/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteDatum"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table, record history, discrete attribute or datum not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/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.",
+ "operationId": "AppendValuesForDiscreteAttribute",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendDiscreteValues"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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 7": {
+ "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 8": {
+ "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 7": {
+ "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 8": {
+ "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 7": {
+ "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 8": {
+ "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/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteDatum"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "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}/point:append-values": {
+ "post": {
+ "tags": [
+ "Data"
+ ],
+ "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",
+ "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/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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"}}}]}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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"}}}]}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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"}}}]}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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"}}}]}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaPointDatum"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table, record history, point attribute or datum not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": {
+ "post": {
+ "tags": [
+ "Data"
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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"}}}]}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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"}}}]}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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"}}}]}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppendPointValues"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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"}}}]}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaPointDatum"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, record history, point attribute or datum not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}:search-index-status": {
+ "get": {
+ "tags": [
+ "Database"
+ ],
+ "summary": "Get Search Index Status for a given database",
+ "operationId": "GetSearchIndexStatus",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "include-errors",
+ "in": "query",
+ "description": "",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "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"
+ },
+ "404": {
+ "description": "Database key not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-identity}: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": "GenerateSchemaFromTable",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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": "database-key",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-name",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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": "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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/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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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 15": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "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 16": {
+ "summary": "Data Export with record history IDs",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training' by specifying the record history IDs.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 21": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 22": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 23": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 24": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 27": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 28": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportRequest"
+ },
+ "examples": {
+ "Example 15": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "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 16": {
+ "summary": "Data Export with record history IDs",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training' by specifying the record history IDs.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 21": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 22": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 23": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 24": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 27": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 28": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportRequest"
+ },
+ "examples": {
+ "Example 15": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "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 16": {
+ "summary": "Data Export with record history IDs",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training' by specifying the record history IDs.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 21": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 22": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 23": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 24": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 27": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 28": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportRequest"
+ },
+ "examples": {
+ "Example 15": {
+ "summary": "Data Export",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training'.",
+ "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 16": {
+ "summary": "Data Export with record history IDs",
+ "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the 'MaterialUniverse' records 'Alumino Silicate - 1720' and '250 Maraging Steel' in database 'MI Training' by specifying the record history IDs.",
+ "value": {"attributes":[{"attributeType":"simple","guid":"00000144-0001-4fff-8fff-dd92ffff0000"},{"attributeType":"simple","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"}],"recordProperties":["fullName","recordColor"],"recordHistoryIdentities":[8925,11331]}
+ },
+ "Example 17": {
+ "summary": "Linked Records Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 18": {
+ "summary": "Linked Records Export - no target specified",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 19": {
+ "summary": "Linked Records Export - In Reversed Direction",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Test Data' record 'MTS-615721' in database 'MI Training', 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"],"recordHistoryIdentities":[120738]}
+ },
+ "Example 20": {
+ "summary": "Linked Records Export - include indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 21": {
+ "summary": "Linked Records Export - exclude indirect links",
+ "description": "This example demonstrates how to export linked records from the 'Tensile Statistical Data' record '300°F' in database 'MI Training', 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"],"recordHistoryIdentities":[120483]}
+ },
+ "Example 22": {
+ "summary": "Linked Records Export - Dynamic Link",
+ "description": "This example demonstrates how to export linked records from the 'Composite Pedigree' record 'LBU14' in database 'MI Training', 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"],"recordHistoryIdentities":[121939]}
+ },
+ "Example 23": {
+ "summary": "Linked Data Export",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 24": {
+ "summary": "Linked Data Export - Rollup",
+ "description": "This example demonstrates how to export linked records from the 'Metals Pedigree' record 'Batch 921' in database 'MI Training', 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"],"recordHistoryIdentities":[120139]}
+ },
+ "Example 25": {
+ "summary": "Tabular Data Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 26": {
+ "summary": "Tabular Data Export - no target specified",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 27": {
+ "summary": "Tabular Data Filtered Export",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', 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","linkedRecordsCriterion":{"subsetGuid":"883ab52b-01b6-4a15-a89a-2bfa17c8d0e9","type":"subset"}},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ },
+ "Example 28": {
+ "summary": "Tabular Data With Summary Row and Tabular Rollup",
+ "description": "This example demonstrates how to export tabular data from the 'Material Universe' record 'Barium silicate' in database 'MI Training', from the tabular attribute 'Restricted substances associated with this material'.It will include a tabular rollup of the maximum of the 'SVHC under REACH', 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"},"indirectLinksBehavior":"fromLinkDefinition","guid":"51e51832-0bcc-4fe0-bb95-ddd6917dc554"}],"recordProperties":["fullName"],"recordHistoryIdentities":[8930]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:export": {
+ "post": {
+ "tags": [
+ "DataExport"
+ ],
+ "summary": "Export data from the integration schema.",
+ "operationId": "ExportDataFromIntegrationSchema",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationDataExportRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationDataExportRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationDataExportRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationDataExportRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportResponse"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportResponse"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataExportResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/help-location/url/{help-key}": {
+ "get": {
+ "tags": [
+ "HelpLocation"
+ ],
+ "summary": "Returns the URL that the given helpKey maps to.",
+ "operationId": "GetHelpUrl",
+ "parameters": [
+ {
+ "name": "help-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",
+ "in": "path",
+ "description": "The help key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "302": {
+ "description": "Redirect to the help location."
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Lists the available integration schemas.",
+ "operationId": "Schemas",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}:search-index-status": {
+ "get": {
+ "tags": [
+ "Integration"
+ ],
+ "summary": "Returns the status of a given integration schema.",
+ "operationId": "GetStatusForIntegrationSchema",
+ "parameters": [
+ {
+ "name": "schema",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "include-errors",
+ "in": "query",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaStatus"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaStatus"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaStatus"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "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",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaStatus"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaStatus"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaStatus"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}": {
+ "put": {
+ "tags": [
+ "Integration"
+ ],
+ "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": "schema",
+ "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"
+ }
+ }
+ },
+ "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",
+ "in": "path",
+ "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": "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Schema not found"
+ }
+ }
+ }
+ },
+ "/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": "Success",
+ "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": "Schema not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/integration-schemas/{schema}/sources/database/{database-key}/table/{table-identity}": {
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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"
+ }
+ }
+ }
+ },
+ "/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": "Success",
+ "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": {
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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": "Success"
+ },
+ "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": "Success",
+ "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": "Success"
+ },
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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": "Success",
+ "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 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"appNames":["MI BoM Analyzer"]}
+ },
+ "Example 4": {
+ "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": {"appNames":["RS Reports","Sustainability Analytics"]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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": "Success",
+ "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/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"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateRecordListProperties"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateRecordListProperties"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateRecordListProperties"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Update the name of list",
+ "description": "Update the name of a list",
+ "value": {"name":"new name","published":false,"awaitingApproval":false,"internalUse":false}
+ },
+ "Example 4": {
+ "summary": "Update everything for a list",
+ "description": "Update everything for a list",
+ "value": {"name":"new name","description":"new description","notes":"new notes","published":false,"awaitingApproval":true,"internalUse":true}
+ }
+ }
+ }
+ }
+ },
+ "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/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"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "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",
+ "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"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUserPermissionsInfo"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUserPermissionsInfo"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUserPermissionsInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Record list or user or group not found"
+ }
+ }
+ }
+ },
+ "/api/v1/lists/list/{listIdentifier}/permissions/user/{userIdentifier}": {
+ "get": {
+ "tags": [
+ "ListPermissions"
+ ],
+ "summary": "Gets the permission flags of the permission associating the specified list with the specified user.",
+ "operationId": "GetPermissionsForUser",
+ "parameters": [
+ {
+ "name": "listIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "userIdentifier",
+ "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",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "userIdentifier",
+ "in": "path",
+ "required": true,
+ "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"
+ }
+ }
+ }
+ },
+ "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",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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}": {
+ "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",
+ "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": "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/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":"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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "record-history-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/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":"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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateRecordHistory"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"983bf68f-ceea-491b-badb-6c56abd95c06"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"983bf68f-ceea-491b-badb-6c56abd95c06"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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"}}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateRecordHistory"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"983bf68f-ceea-491b-badb-6c56abd95c06"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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":"983bf68f-ceea-491b-badb-6c56abd95c06"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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"}}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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":"89d01e7a-2d58-42cf-ab21-d1d91529db7a"}],"subsets":[],"guid":"26810290-3941-4f2d-ac98-82d74a299eec"}
+ }
+ }
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveRecordHistory"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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 5": {
+ "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 6": {
+ "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 5": {
+ "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 6": {
+ "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 5": {
+ "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 6": {
+ "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":{"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 11": {
+ "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 12": {
+ "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":[{"message":"New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.","reason":"ParentNotInSameTable"}]}
+ },
+ "Example 13": {
+ "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":[{"message":"A record with the short name 'Sheet' already exists in the parent folder.","reason":"ShortNameExistsInFolder"}]}
+ },
+ "Example 14": {
+ "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 15": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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 7": {
+ "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 8": {
+ "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 7": {
+ "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 8": {
+ "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 7": {
+ "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 8": {
+ "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 7": {
+ "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 8": {
+ "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":{"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 16": {
+ "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 17": {
+ "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":[{"message":"New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.","reason":"ParentNotInSameTable"}]}
+ },
+ "Example 18": {
+ "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":[{"message":"A record with the short name 'Sheet' already exists in the parent folder.","reason":"ShortNameExistsInFolder"}]}
+ },
+ "Example 19": {
+ "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 20": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCopyRecordHistory"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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 9": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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":"1c7360ea-0397-4ec1-a2be-023a7c76ccc1"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRecordHistoryCopyException"
+ },
+ "examples": {
+ "Example 9": {
+ "summary": "New parent is not a folder.",
+ "value": {"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 10": {
+ "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 11": {
+ "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 12": {
+ "summary": "New parent is withdrawn.",
+ "value": {"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"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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":"ad42085d-daa2-424f-bc33-ade0323a7e15"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRecordHistoryCopyException"
+ },
+ "examples": {
+ "Example 13": {
+ "summary": "New parent is not a folder.",
+ "value": {"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 14": {
+ "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 15": {
+ "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 16": {
+ "summary": "New parent is withdrawn.",
+ "value": {"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"}]}
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or record history not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/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 and table.",
+ "operationId": "GetLatestRecordVersionFromTable",
+ "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": "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Alumino silicate - 1720","recordColor":"fuchsia","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",
+ "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/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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Alumino silicate - 1720","recordColor":"fuchsia","versionNumber":1,"versionState":"unversioned","name":"Alumino silicate - 1720","guid":"00000026-000e-4fff-8fff-dd92ffff0000"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or record history not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}": {
+ "get": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "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",
+ "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": "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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Alumino silicate - 1720","recordColor":"fuchsia","versionNumber":1,"versionState":"unversioned","name":"Alumino silicate - 1720","guid":"00000026-000e-4fff-8fff-dd92ffff0000"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table, record history or record version 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",
+ "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"
+ }
+ }
+ ],
+ "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": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "summary": "Releases the record version. Must be an unreleased record version.",
+ "operationId": "ReleaseRecordVersion",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Arsenic trioxide [1327-53-3]","recordColor":"red","versionNumber":1,"versionState":"released","name":"Arsenic trioxide [1327-53-3]","guid":"e1a72a7e-155e-47f9-b6c9-285fd5d3288a"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Record version state is not unreleased, or table is not version controlled, or parent is not released.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaReleaseRecordVersionControlException"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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 6": {
+ "summary": "Parent is not released.",
+ "value": {"message":"Cannot release record version with GUID 'e0f48356-b97a-4fc4-9b1e-45a35d53e498'.","code":400,"errors":[{"message":"Tree parent is not in a valid state to perform this operation.","reason":"invalidParentState"}]}
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "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}:get-modifiable-version": {
+ "post": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "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": "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"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Arsenic trioxide [1327-53-3]","recordColor":"red","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 4": {
+ "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 5": {
+ "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 6": {
+ "summary": "Record version is not the latest version.",
+ "value": {"message":"Cannot create a new version from the record version with GUID '3e8ed6d7-23c3-4602-935e-4341ed330b3a'.","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":"019f219f-9667-4c58-9141-9c7d27d6c2eb"}}]}
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "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}:withdraw": {
+ "post": {
+ "tags": [
+ "Records - Record Versions"
+ ],
+ "summary": "Withdraws the record version. Must be a released record version.",
+ "operationId": "WithdrawRecordVersion",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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-05:00","lastModifiedByUser":"A User","lastModifiedDate":"2018-01-02T00:00:00-05:00","recordType":"record","shortName":"Arsenic trioxide [1327-53-3]","recordColor":"red","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 3": {
+ "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 4": {
+ "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": "Database, table, record history or record version not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/schema/mi-version": {
+ "get": {
+ "tags": [
+ "Schema"
+ ],
+ "summary": "Returns the currently running MI version to the caller.",
+ "operationId": "GetVersion",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMiVersion"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/security-attribute-groupings": {
+ "get": {
+ "tags": [
+ "Schema"
+ ],
+ "summary": "Gets all security attribute groupings for a given database.",
+ "operationId": "GetSecurityAttributeGroupings",
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSecurityAttributeGrouping"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get all attributes in table",
+ "operationId": "GetAttributes",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Create a new attribute.",
+ "operationId": "CreateAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateAttribute"
+ },
+ "examples": {
+ "Example 26": {
+ "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 27": {
+ "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":"2205a822-84be-4789-b305-2e2d84768251"}
+ },
+ "Example 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "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 45": {
+ "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 46": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateAttribute"
+ },
+ "examples": {
+ "Example 26": {
+ "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 27": {
+ "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":"2205a822-84be-4789-b305-2e2d84768251"}
+ },
+ "Example 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "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 45": {
+ "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 46": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateAttribute"
+ },
+ "examples": {
+ "Example 26": {
+ "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 27": {
+ "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":"2205a822-84be-4789-b305-2e2d84768251"}
+ },
+ "Example 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "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 45": {
+ "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 46": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateAttribute"
+ },
+ "examples": {
+ "Example 26": {
+ "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 27": {
+ "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":"2205a822-84be-4789-b305-2e2d84768251"}
+ },
+ "Example 28": {
+ "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 29": {
+ "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 30": {
+ "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 31": {
+ "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 32": {
+ "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 33": {
+ "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 34": {
+ "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 35": {
+ "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 36": {
+ "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 37": {
+ "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 38": {
+ "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 39": {
+ "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 40": {
+ "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 41": {
+ "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 42": {
+ "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 43": {
+ "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 44": {
+ "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 45": {
+ "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 46": {
+ "summary": "Short text meta-attribute",
+ "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute in the MaterialUniverse (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database. Any attribute type can be used for meta-attributes.",
+ "value": {"type":"shortText","isUnique":false,"defaultThresholdType":"exists","aboutAttribute":{"guid":"000000b9-0001-4fff-8fff-dd92ffff0000"},"name":"Short Label"}
+ },
+ "Example 47": {
+ "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 48": {
+ "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 49": {
+ "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 50": {
+ "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": {
+ "201": {
+ "description": "Created",
+ "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":[],"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 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":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"type":"discrete","isHiddenFromSearchCriteria":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","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":"173887f5-a0b7-4ac6-bdbf-d1b220270361"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"type":"range","isHiddenFromSearchCriteria":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,"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":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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 table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get attribute in table",
+ "operationId": "GetAttribute",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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":"d1f7062a-df23-4147-b203-40c8a1536cb4"}],"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":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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 or attribute not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Update attribute.",
+ "operationId": "UpdateAttribute",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ "examples": {
+ "Example 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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 22": {
+ "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 23": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 24": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 25": {
+ "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 26": {
+ "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 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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": {"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"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ "examples": {
+ "Example 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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 22": {
+ "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 23": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 24": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 25": {
+ "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 26": {
+ "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 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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": {"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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ "examples": {
+ "Example 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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 22": {
+ "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 23": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 24": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 25": {
+ "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 26": {
+ "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 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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": {"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"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ "examples": {
+ "Example 16": {
+ "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 17": {
+ "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 18": {
+ "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 19": {
+ "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 20": {
+ "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 21": {
+ "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 22": {
+ "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 23": {
+ "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": {"type":"point","isMultiValued":true}
+ },
+ "Example 24": {
+ "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": {"type":"point","isMultiValued":true,"attributeParameters":[{"guid":"00000001-000a-4fff-8fff-0000ffff0000"}]}
+ },
+ "Example 25": {
+ "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 26": {
+ "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 27": {
+ "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 28": {
+ "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 29": {
+ "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 30": {
+ "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": {"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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ "examples": {
+ "Example 29": {
+ "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 30": {
+ "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 31": {
+ "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":"ffee1247-7149-42b1-ba24-23c1665289e5"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"type":"range","isHiddenFromSearchCriteria":false,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"displayNames":{},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 32": {
+ "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":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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 or attribute not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Delete an attribute.",
+ "operationId": "DeleteAttribute",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request. Attribute in use.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAttributeDeletionException"
+ },
+ "example": {"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 attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get all meta-attributes in table",
+ "operationId": "GetMetaAttributes",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get meta-attribute in table",
+ "operationId": "GetMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "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":[],"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 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":[],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"type":"discrete","isHiddenFromSearchCriteria":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","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":"787b001d-77ea-4aae-b998-165a5eff804d"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"type":"range","isHiddenFromSearchCriteria":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,"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":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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 or meta-attribute not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Update meta-attribute.",
+ "operationId": "UpdateMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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 10": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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 10": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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 10": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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 10": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ "examples": {
+ "Example 37": {
+ "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 38": {
+ "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 39": {
+ "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":"0e15cabf-1535-4a33-92c0-a27ac1a25849"}],"primaryDynamicLinkGroups":[],"foreignDynamicLinkGroups":[]},"type":"range","isHiddenFromSearchCriteria":false,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"displayNames":{},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"}
+ },
+ "Example 40": {
+ "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":{"name":"Legislation rating","guid":"49a720bd-55c4-44a3-a10a-5ae3b69f3100"},"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 or meta-attribute not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Delete a meta-attribute.",
+ "operationId": "DeleteMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAttributeDeletionException"
+ },
+ "example": {"message":"Cannot delete attribute 'Notes' (GUID = 'fbedf8cc-6bcf-4610-90b4-30d1df6c095c').","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":[{"name":"Search mask that searches in Notes","guid":"43932fe8-97be-4990-9ecf-bd8b8fa8a631"}]}]}
+ }
+ }
+ },
+ "200": {
+ "description": "OK"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or meta-attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes": {
+ "get": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Get meta-attributes for attribute",
+ "operationId": "GetMetaAttributesForAttribute",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAttributesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}:validate": {
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Validates the provided value against the attributes data rules.",
+ "operationId": "ValidateAttribute",
+ "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"
+ }
+ }
+ ],
+ "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 attribute not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}:validate": {
+ "post": {
+ "tags": [
+ "Schema - Attributes"
+ ],
+ "summary": "Validates the provided value against the meta attributes data rules.",
+ "operationId": "ValidateMetaAttribute",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "meta-attribute-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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",
+ "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": "Fetch properties for attributes. Optionally filter the returned attributes.",
+ "operationId": "QueryAttributes",
+ "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 5": {
+ "summary": "Fetch all attributes with unit and meta attributes",
+ "value": {"properties":{"type":true,"info":{"orderedMetaAttributes":{"name":true}},"unit":{"symbol":true},"name":true,"guid":true}}
+ },
+ "Example 6": {
+ "summary": "Fetch all attributes with custom properties",
+ "value": {"properties":{"type":true,"defaultThresholdType":true,"isHiddenFromSearchCriteria":true,"info":{"chartable":true,"orderedMetaAttributes":{"name":true,"guid":true}},"unit":{"name":true,"symbol":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},"name":true,"guid":true}}
+ },
+ "Example 7": {
+ "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":{"name":true,"guid":true},"name":true,"guid":true},"filter":{"type":["link"]}}
+ },
+ "Example 8": {
+ "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"]}}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaQueryAttributesRequest"
+ },
+ "examples": {
+ "Example 5": {
+ "summary": "Fetch all attributes with unit and meta attributes",
+ "value": {"properties":{"type":true,"info":{"orderedMetaAttributes":{"name":true}},"unit":{"symbol":true},"name":true,"guid":true}}
+ },
+ "Example 6": {
+ "summary": "Fetch all attributes with custom properties",
+ "value": {"properties":{"type":true,"defaultThresholdType":true,"isHiddenFromSearchCriteria":true,"info":{"chartable":true,"orderedMetaAttributes":{"name":true,"guid":true}},"unit":{"name":true,"symbol":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},"name":true,"guid":true}}
+ },
+ "Example 7": {
+ "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":{"name":true,"guid":true},"name":true,"guid":true},"filter":{"type":["link"]}}
+ },
+ "Example 8": {
+ "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"]}}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaQueryAttributesRequest"
+ },
+ "examples": {
+ "Example 5": {
+ "summary": "Fetch all attributes with unit and meta attributes",
+ "value": {"properties":{"type":true,"info":{"orderedMetaAttributes":{"name":true}},"unit":{"symbol":true},"name":true,"guid":true}}
+ },
+ "Example 6": {
+ "summary": "Fetch all attributes with custom properties",
+ "value": {"properties":{"type":true,"defaultThresholdType":true,"isHiddenFromSearchCriteria":true,"info":{"chartable":true,"orderedMetaAttributes":{"name":true,"guid":true}},"unit":{"name":true,"symbol":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},"name":true,"guid":true}}
+ },
+ "Example 7": {
+ "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":{"name":true,"guid":true},"name":true,"guid":true},"filter":{"type":["link"]}}
+ },
+ "Example 8": {
+ "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"]}}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaQueryAttributesRequest"
+ },
+ "examples": {
+ "Example 5": {
+ "summary": "Fetch all attributes with unit and meta attributes",
+ "value": {"properties":{"type":true,"info":{"orderedMetaAttributes":{"name":true}},"unit":{"symbol":true},"name":true,"guid":true}}
+ },
+ "Example 6": {
+ "summary": "Fetch all attributes with custom properties",
+ "value": {"properties":{"type":true,"defaultThresholdType":true,"isHiddenFromSearchCriteria":true,"info":{"chartable":true,"orderedMetaAttributes":{"name":true,"guid":true}},"unit":{"name":true,"symbol":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},"name":true,"guid":true}}
+ },
+ "Example 7": {
+ "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":{"name":true,"guid":true},"name":true,"guid":true},"filter":{"type":["link"]}}
+ },
+ "Example 8": {
+ "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"]}}
+ }
+ }
+ }
+ }
+ },
+ "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}/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"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaConfigurationsInfo"
+ },
+ "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"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"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":"af414144-c207-4591-ad77-09315fc5932d"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"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":"af414144-c207-4591-ad77-09315fc5932d"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"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":"af414144-c207-4591-ad77-09315fc5932d"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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","guid":"00000000-0000-0000-0000-000000000000"}
+ },
+ "Example 4": {
+ "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": {"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":"af414144-c207-4591-ad77-09315fc5932d"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaConfiguration"
+ },
+ "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 not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Get individual configuration",
+ "operationId": "GetConfiguration",
+ "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"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "configuration-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaConfiguration"
+ },
+ "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 or configuration not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Configurations"
+ ],
+ "summary": "Update a configuration.",
+ "operationId": "UpdateConfiguration",
+ "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"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "configuration-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3facbc1d-8b5f-4991-9889-9c4ca2d1458c"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3facbc1d-8b5f-4991-9889-9c4ca2d1458c"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3facbc1d-8b5f-4991-9889-9c4ca2d1458c"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateConfiguration"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3facbc1d-8b5f-4991-9889-9c4ca2d1458c"}
+ },
+ "Example 4": {
+ "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": {"name":"examples (updated)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaConfiguration"
+ },
+ "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"
+ ],
+ "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"
+ ],
+ "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 4": {
+ "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 5": {
+ "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":"c76ad3dd-d70d-4729-a456-ea5fb141db50"}
+ },
+ "Example 6": {
+ "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": {"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 4": {
+ "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 5": {
+ "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":"c76ad3dd-d70d-4729-a456-ea5fb141db50"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum (guid and unit)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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 5": {
+ "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":"c76ad3dd-d70d-4729-a456-ea5fb141db50"}
+ },
+ "Example 6": {
+ "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": {"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 4": {
+ "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 5": {
+ "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":"c76ad3dd-d70d-4729-a456-ea5fb141db50"}
+ },
+ "Example 6": {
+ "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": {"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": {"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 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/GsaUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"bf69e801-e9f6-40ef-901c-2d619d9ede74"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"ff59c624-bd5d-41b8-850f-a92c0a700872"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"bf69e801-e9f6-40ef-901c-2d619d9ede74"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"ff59c624-bd5d-41b8-850f-a92c0a700872"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"bf69e801-e9f6-40ef-901c-2d619d9ede74"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"ff59c624-bd5d-41b8-850f-a92c0a700872"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateConstant"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","value":376.730313668,"name":"characteristic impedance of vacuum","guid":"bf69e801-e9f6-40ef-901c-2d619d9ede74"}
+ },
+ "Example 5": {
+ "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": {"name":"characteristic impedance of vacuum"}
+ },
+ "Example 6": {
+ "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": {"unitGuid":"00000059-0013-4fff-8fff-0000ffff0000","guid":"ff59c624-bd5d-41b8-850f-a92c0a700872"}
+ }
+ }
+ }
+ }
+ },
+ "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"}
+ }
+ }
+ },
+ "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": {"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":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}]}
+ }
+ }
+ },
+ "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 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateDataRule"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Data rule for attributes",
+ "description": "This example demonstrates how to create a new data rule.",
+ "value": {"description":"Only numeric digits are allowed.","regularExpression":"^[0-9]*$","name":"digits only"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataRule"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/data-rules/{data-rule-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Gets a data rule for a given database and guid.",
+ "operationId": "GetDataRule",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "data-rule-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDataRule"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or data rule not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Data Rules"
+ ],
+ "summary": "Edit a data rule",
+ "operationId": "UpdateDataRule",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "data-rule-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "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/GsaDataRule"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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."
+ }
+ }
+ }
+ },
+ "/v1alpha/databases": {
+ "get": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Lists all databases that the user can see.",
+ "operationId": "GetAllDatabases",
+ "parameters": [
+ {
+ "name": "role",
+ "in": "query",
+ "schema": {
+ "enum": [
+ "read",
+ "write",
+ "powerUser",
+ "grant",
+ "admin"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDatabasesInfo"
+ },
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"ffbf0831-15d8-44c2-a08d-ee04189215a8","guid":"2b5db178-b7cf-4f63-af62-03af33b090f8","name":"MI Training (Updated)"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"ffbf0831-15d8-44c2-a08d-ee04189215a8","guid":"2b5db178-b7cf-4f63-af62-03af33b090f8","name":"MI Training (Updated)"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"ffbf0831-15d8-44c2-a08d-ee04189215a8","guid":"2b5db178-b7cf-4f63-af62-03af33b090f8","name":"MI Training (Updated)"}
+ },
+ "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)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDatabase"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"ffbf0831-15d8-44c2-a08d-ee04189215a8","guid":"2b5db178-b7cf-4f63-af62-03af33b090f8","name":"MI Training (Updated)"}
+ },
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "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}:upgrade": {
+ "post": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "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",
+ "required": true,
+ "schema": {
+ "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\" or \"Unknown\" state"
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database not found."
+ }
+ }
+ }
+ },
+ "/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": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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": "database-key",
+ "in": "path",
+ "description": "Database to lock",
+ "required": true,
+ "schema": {
+ "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}:unlock": {
+ "post": {
+ "tags": [
+ "Schema - Databases"
+ ],
+ "summary": "Unlock database",
+ "operationId": "UnlockDatabase",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "description": "Database to unlock",
+ "required": true,
+ "schema": {
+ "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": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GsaCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GsaCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GsaCreateDiscreteType"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteType"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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/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": "discrete-type-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteType"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteType"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteType"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteType"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteType"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request."
+ },
+ "403": {
+ "description": "Forbidden."
+ },
+ "404": {
+ "description": "Database or discrete type not found."
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Discrete Types"
+ ],
+ "summary": "Delete discrete type, including all of its discrete values.",
+ "operationId": "DeleteDiscreteType",
+ "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": {
+ "400": {
+ "description": "Bad request. Discrete type in use by Attributes.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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"}]}]}
+ }
+ }
+ },
+ "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",
+ "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/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/{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 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c03eda55-d47b-4a15-b1a0-36cee7f70ec2"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c03eda55-d47b-4a15-b1a0-36cee7f70ec2"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c03eda55-d47b-4a15-b1a0-36cee7f70ec2"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Discrete Value",
+ "description": "This example demonstrates how to create a new discrete value.",
+ "value": {"name":"New Discrete Value 1"}
+ },
+ "Example 4": {
+ "summary": "Discrete Value with Guid",
+ "description": "This example demonstrates how to create a new discrete value with a specified guid value.",
+ "value": {"name":"New Discrete Value 2","guid":"c03eda55-d47b-4a15-b1a0-36cee7f70ec2"}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request. e.g. would delete a discrete value that is in use."
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or discrete type not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values/{discrete-value-guid}": {
+ "get": {
+ "tags": [
+ "Schema - DiscreteTypes - DiscreteValues"
+ ],
+ "summary": "Gets specific discrete value for a given discreteType within a given database.",
+ "operationId": "GetDiscreteValue",
+ "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": {
+ "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": "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"
+ }
+ }
+ ],
+ "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."
+ },
+ "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/GsaDiscreteValueDeletionException"
+ },
+ "example": {"message":"Cannot delete discrete value 'Unacceptable' (GUID = '00000583-0007-4fff-8fff-0083ffff0000').","code":400,"errors":[{"message":"It is being used in one or more data items.","reason":"usage","referencedByType":"data"}]}
+ }
+ }
+ },
+ "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": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFoldersInfo"
+ },
+ "example": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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": {"folders":[{"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"},{"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 2": {
+ "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/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "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/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"
+ },
+ "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": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$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"}
+ }
+ }
+ },
+ "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": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","name":"Abaqus","guid":"41aba877-8fe0-4295-bddb-6f8b270a40ff"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "example": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","name":"Abaqus","guid":"41aba877-8fe0-4295-bddb-6f8b270a40ff"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "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 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"b3143ccd-e812-4a58-ba48-c8e652f44e30"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"b3143ccd-e812-4a58-ba48-c8e652f44e30"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"b3143ccd-e812-4a58-ba48-c8e652f44e30"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Exporter Folder",
+ "description": "This example demonstrates how to rename an existing Exporter folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Exporter Folder",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter folder.",
+ "value": {"guid":"b3143ccd-e812-4a58-ba48-c8e652f44e30"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "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/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"
+ },
+ "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": {"folders":[{"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": {"folders":[{"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": {"folders":[{"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 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",
+ "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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/exporters/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Exporters"
+ ],
+ "summary": "Move an existing Exporter Folder.",
+ "operationId": "MoveExportersFolder",
+ "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/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter Folder",
+ "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.",
+ "value": {"parentGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "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/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"
+ },
+ "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": {"files":[{"name":"exporter-1.exp","guid":"37f61dbd-a33f-4852-b75a-385893c005cf"},{"name":"no-transform.xslt","guid":"438dae53-312b-4028-a7df-3d6bcc135f1e"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"37f61dbd-a33f-4852-b75a-385893c005cf"},{"name":"no-transform.xslt","guid":"438dae53-312b-4028-a7df-3d6bcc135f1e"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFilesInfo"
+ },
+ "example": {"files":[{"name":"exporter-1.exp","guid":"37f61dbd-a33f-4852-b75a-385893c005cf"},{"name":"no-transform.xslt","guid":"438dae53-312b-4028-a7df-3d6bcc135f1e"}]}
+ }
+ }
+ },
+ "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": {
+ "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":"c92b3dac-f3b1-4f77-8add-cf458769b65a"}
+ },
+ "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":"c92b3dac-f3b1-4f77-8add-cf458769b65a"}
+ },
+ "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":"c92b3dac-f3b1-4f77-8add-cf458769b65a"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44","description":"Description of exporter file.","extension":"exp","dataLength":12895,"path":"Exporters","name":"exporter-1.exp","guid":"64db2a90-67bf-4b73-98b1-ecd768f9cf56"}
+ },
+ "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":"64db2a90-67bf-4b73-98b1-ecd768f9cf56"}
+ },
+ "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":"64db2a90-67bf-4b73-98b1-ecd768f9cf56"}
+ }
+ }
+ },
+ "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",
+ "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/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"6a5fcdbd-7fb6-4a0a-b0a5-e8d0458ffd17"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"6a5fcdbd-7fb6-4a0a-b0a5-e8d0458ffd17"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"6a5fcdbd-7fb6-4a0a-b0a5-e8d0458ffd17"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Exporter File",
+ "description": "This example demonstrates how to rename an existing Exporter file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for an Exporter File",
+ "description": "This example demonstrates how to change the description for an existing Exporter file.",
+ "value": {"description":"New description for Exporter file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Exporter File",
+ "description": "This example demonstrates how to modify the guid of an existing Exporter file.",
+ "value": {"guid":"6a5fcdbd-7fb6-4a0a-b0a5-e8d0458ffd17"}
+ }
+ }
+ }
+ }
+ },
+ "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":"4f1b7fae-f7db-40bb-a918-431952ab3012"}
+ },
+ "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":"4f1b7fae-f7db-40bb-a918-431952ab3012"}
+ },
+ "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":"4f1b7fae-f7db-40bb-a918-431952ab3012"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ },
+ "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": "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"
+ },
+ "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 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Exporter File",
+ "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.",
+ "value": {"folderGuid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ }
+ }
+ }
+ }
+ },
+ "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":"0c580611-ffc4-4a38-aaea-a5233cf70ea6"}
+ },
+ "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":"0c580611-ffc4-4a38-aaea-a5233cf70ea6"}
+ },
+ "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":"0c580611-ffc4-4a38-aaea-a5233cf70ea6"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions": {
+ "get": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Get all expressions for table",
+ "operationId": "GetExpressions",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaExpressionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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":[{"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Create a new expression.",
+ "operationId": "CreateExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"323e6139-5996-440b-98aa-c9ce3fea537c"}
+ },
+ "Example 6": {
+ "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/GsaCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"323e6139-5996-440b-98aa-c9ce3fea537c"}
+ },
+ "Example 6": {
+ "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/GsaCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"323e6139-5996-440b-98aa-c9ce3fea537c"}
+ },
+ "Example 6": {
+ "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/GsaCreateExpression"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression"}
+ },
+ "Example 5": {
+ "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": {"value":"[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5","name":"Simple expression with specified guid","guid":"323e6139-5996-440b-98aa-c9ce3fea537c"}
+ },
+ "Example 6": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaExpression"
+ },
+ "examples": {
+ "Example 5": {
+ "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,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":false,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":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,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":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"}],"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or table not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Get an expression with a specified guid for a given database and table.",
+ "operationId": "GetExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "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": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaExpression"
+ },
+ "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,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":false,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":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,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":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"}],"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or expression not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Update an expression.",
+ "operationId": "UpdateExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "expression-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3387c203-8e5a-480c-a1bd-6d9a3abc570c"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3387c203-8e5a-480c-a1bd-6d9a3abc570c"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3387c203-8e5a-480c-a1bd-6d9a3abc570c"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateExpression"
+ },
+ "examples": {
+ "Example 3": {
+ "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": {"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":"3387c203-8e5a-480c-a1bd-6d9a3abc570c"}
+ },
+ "Example 4": {
+ "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": {"name":"Fatigue Model (Updated)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaExpression"
+ },
+ "examples": {
+ "Example 6": {
+ "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,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Young's modulus","guid":"0000003f-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":false,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Tensile strength","guid":"000000e3-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":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,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Elongation","guid":"0000011a-0001-4fff-8fff-dd92ffff0000"},{"type":"range","isHiddenFromSearchCriteria":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"}],"name":"Fatigue Model","guid":"535074aa-216f-4f60-b13e-f5e8be72d05f"}
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or expression not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Expressions"
+ ],
+ "summary": "Delete an expression.",
+ "operationId": "DeleteExpression",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$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": {"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"}]}
+ },
+ "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"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Create a new Help File Folder.",
+ "operationId": "CreateHelpFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Help File Folder",
+ "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.",
+ "value": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"New Folder"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "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/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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/:root-folder": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Root Help File Folder",
+ "operationId": "GetHelpRootFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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": "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22","name":"html","guid":"99ff4816-15e9-42b9-9ac3-b60fce881e85"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "example": {"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 folder not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Update an existing Help File Folder.",
+ "operationId": "UpdateHelpFolder",
+ "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 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"68ff219a-a72c-4724-b3e9-bcabe9bd0c02"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"68ff219a-a72c-4724-b3e9-bcabe9bd0c02"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"68ff219a-a72c-4724-b3e9-bcabe9bd0c02"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Help File Folder",
+ "description": "This example demonstrates how to rename an existing help file folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Help File Folder",
+ "description": "This example demonstrates how to modify the guid of an existing help file folder.",
+ "value": {"guid":"68ff219a-a72c-4724-b3e9-bcabe9bd0c02"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "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/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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Delete a Help File Folder.",
+ "operationId": "DeleteHelpFolder",
+ "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}/help-folders/{folder-guid}:child-folders": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Child Help File Folders",
+ "operationId": "GetHelpChildFolders",
+ "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": {"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"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$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"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$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 or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Move an existing Help File Folder.",
+ "operationId": "MoveHelpFolder",
+ "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/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"parentGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "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/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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files": {
+ "get": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Get Files in a Folder",
+ "operationId": "GetHelpFiles",
+ "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": {"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":"aa3ee888-880c-4adb-83d8-15e71d21b9dc"}
+ },
+ "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":"aa3ee888-880c-4adb-83d8-15e71d21b9dc"}
+ },
+ "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":"aa3ee888-880c-4adb-83d8-15e71d21b9dc"}
+ }
+ }
+ },
+ "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 - Help Files"
+ ],
+ "summary": "Update an existing Help File.",
+ "operationId": "UpdateHelpFile",
+ "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/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"fde42a1b-9102-4d41-a6f2-fb879bf22b72"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"fde42a1b-9102-4d41-a6f2-fb879bf22b72"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"fde42a1b-9102-4d41-a6f2-fb879bf22b72"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Help File",
+ "description": "This example demonstrates how to rename an existing help file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "summary": "Modify the description for a Help File",
+ "description": "This example demonstrates how to change the description for an existing help file.",
+ "value": {"description":"New description for help file."}
+ },
+ "Example 6": {
+ "summary": "Change guid for Help File",
+ "description": "This example demonstrates how to modify the guid of an existing help file.",
+ "value": {"guid":"fde42a1b-9102-4d41-a6f2-fb879bf22b72"}
+ }
+ }
+ }
+ }
+ },
+ "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":"32f0267e-6746-4b06-8380-32f7fa7a19ee"}
+ },
+ "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":"32f0267e-6746-4b06-8380-32f7fa7a19ee"}
+ },
+ "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":"32f0267e-6746-4b06-8380-32f7fa7a19ee"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file 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",
+ "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"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Help Files"
+ ],
+ "summary": "Move an existing Help File.",
+ "operationId": "MoveHelpFile",
+ "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 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "summary": "Move Help File",
+ "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.",
+ "value": {"folderGuid":"e7dbba58-b963-4d1f-bbf4-c8436d00bf22"}
+ }
+ }
+ }
+ }
+ },
+ "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":"2cec7582-f0c2-4659-a449-8a5c1efd1648"}
+ },
+ "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":"2cec7582-f0c2-4659-a449-8a5c1efd1648"}
+ },
+ "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":"2cec7582-f0c2-4659-a449-8a5c1efd1648"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get All Home Page Folders",
+ "operationId": "GetHomePageFolders",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "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":"e56f922e-ca4e-47dd-83af-cb607cbd83b9"}]}
+ },
+ "application/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":"e56f922e-ca4e-47dd-83af-cb607cbd83b9"}]}
+ },
+ "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":"e56f922e-ca4e-47dd-83af-cb607cbd83b9"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Create a new Home Page Folder.",
+ "operationId": "CreateHomePageFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaCreateFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {
+ "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/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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders:root-folder": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Root Home Page Folder",
+ "operationId": "GetHomePageRootFolder",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "example": {"name":"Home Pages","guid":"c13eb185-2558-4b4a-8395-33c031663925"}
+ },
+ "application/json": {
+ "schema": {
+ "$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"}
+ }
+ }
+ },
+ "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",
+ "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": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"1a0d793a-e9b1-4f99-8bb4-ccf48c228dd6"}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"1a0d793a-e9b1-4f99-8bb4-ccf48c228dd6"}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "example": {"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"1a0d793a-e9b1-4f99-8bb4-ccf48c228dd6"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Update an existing Home Page Folder.",
+ "operationId": "UpdateHomePageFolder",
+ "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 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"849c2645-0fc8-41ad-8f6d-7907fdb82294"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"849c2645-0fc8-41ad-8f6d-7907fdb82294"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"849c2645-0fc8-41ad-8f6d-7907fdb82294"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFolder"
+ },
+ "examples": {
+ "Example 3": {
+ "summary": "Rename Home Page Folder",
+ "description": "This example demonstrates how to rename an existing home page folder.",
+ "value": {"name":"New Folder Name"}
+ },
+ "Example 4": {
+ "summary": "Change guid for Home Page Folder",
+ "description": "This example demonstrates how to modify the guid of an existing home page folder.",
+ "value": {"guid":"849c2645-0fc8-41ad-8f6d-7907fdb82294"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "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/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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Delete a Home Page Folder.",
+ "operationId": "DeleteHomePageFolder",
+ "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}/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",
+ "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": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"662f7bd7-9d1e-41b5-a8c4-e5c96f0174d3"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"662f7bd7-9d1e-41b5-a8c4-e5c96f0174d3"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFoldersInfo"
+ },
+ "example": {"folders":[{"parentGuid":"c13eb185-2558-4b4a-8395-33c031663925","name":"images","guid":"662f7bd7-9d1e-41b5-a8c4-e5c96f0174d3"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:move": {
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Move an existing Home Page Folder.",
+ "operationId": "MoveHomePageFolder",
+ "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/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaMoveFolder"
+ },
+ "examples": {
+ "Example 2": {
+ "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",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "example": {"name":"Exporters","guid":"c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44"}
+ },
+ "application/json": {
+ "schema": {
+ "$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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get the Home Page Files in a Folder",
+ "operationId": "GetHomePageFiles",
+ "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": {"files":[{"name":"home-page-1.html","guid":"c61b7fca-fe69-4f68-a8da-c26c61b15ba3"},{"name":"home-page-2.html","guid":"b12f325f-bc06-49af-8380-1819abe305f8"}]}
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"c61b7fca-fe69-4f68-a8da-c26c61b15ba3"},{"name":"home-page-2.html","guid":"b12f325f-bc06-49af-8380-1819abe305f8"}]}
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaFilesInfo"
+ },
+ "example": {"files":[{"name":"home-page-1.html","guid":"c61b7fca-fe69-4f68-a8da-c26c61b15ba3"},{"name":"home-page-2.html","guid":"b12f325f-bc06-49af-8380-1819abe305f8"}]}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "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": {
+ "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":"1777cebd-c437-43e4-b9f7-8bf5a2d028f9"}
+ },
+ "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":"1777cebd-c437-43e4-b9f7-8bf5a2d028f9"}
+ },
+ "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":"1777cebd-c437-43e4-b9f7-8bf5a2d028f9"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database or folder not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get the header information for a Home Page File",
+ "operationId": "GetHomePageFile",
+ "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":"c13eb185-2558-4b4a-8395-33c031663925","description":"Description of home page file.","extension":"html","dataLength":12895,"path":"HomePages","name":"home-page.html","guid":"a5126472-cadb-4fa4-a9a6-cfa01eb2af55"}
+ },
+ "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":"a5126472-cadb-4fa4-a9a6-cfa01eb2af55"}
+ },
+ "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":"a5126472-cadb-4fa4-a9a6-cfa01eb2af55"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Update an existing Home Page File.",
+ "operationId": "UpdateHomePageFile",
+ "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/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"0d4231f0-dbab-48e8-9dbc-3545b092bb21"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"0d4231f0-dbab-48e8-9dbc-3545b092bb21"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"0d4231f0-dbab-48e8-9dbc-3545b092bb21"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateFile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Rename Home Page File",
+ "description": "This example demonstrates how to rename an existing home page file.",
+ "value": {"name":"New File Name"}
+ },
+ "Example 5": {
+ "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 6": {
+ "summary": "Change guid for Home Page File",
+ "description": "This example demonstrates how to modify the guid of an existing home page file.",
+ "value": {"guid":"0d4231f0-dbab-48e8-9dbc-3545b092bb21"}
+ }
+ }
+ }
+ }
+ },
+ "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":"4f37ce6c-4943-49d7-bc89-24f942d676b8"}
+ },
+ "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":"4f37ce6c-4943-49d7-bc89-24f942d676b8"}
+ },
+ "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":"4f37ce6c-4943-49d7-bc89-24f942d676b8"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:export": {
+ "get": {
+ "tags": [
+ "Schema - Home Pages"
+ ],
+ "summary": "Get Home Page File as a file",
+ "operationId": "ExportHomePageFile",
+ "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"
+ },
+ "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": "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 2": {
+ "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/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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/GsaMoveFile"
+ },
+ "examples": {
+ "Example 2": {
+ "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",
+ "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":"60336458-351b-4c31-bfa1-6a88e0b51ce5"}
+ },
+ "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":"60336458-351b-4c31-bfa1-6a88e0b51ce5"}
+ },
+ "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":"60336458-351b-4c31-bfa1-6a88e0b51ce5"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, folder or file not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections": {
+ "get": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Get all sections for a layout",
+ "operationId": "GetLayoutSections",
+ "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/GsaLayoutSectionsInfo"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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":"aa31b92c-f8d0-46d9-98d5-577e96a890fd","name":"Price","guid":"d01ab800-d6e8-4203-a205-31b19280b988"},{"itemType":"attribute","attributeType":"point","required":false,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"7be988a5-dbde-48b9-9427-125da6c1021f","name":"Density","guid":"552c6b7b-710c-44c7-bcb6-754beac6ea38"}],"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":"d145fbc6-867a-44c4-809e-490a1d697115","name":"Young's modulus","guid":"225adcbe-e5ee-474a-af54-e845a5c609ce"},{"itemType":"attribute","attributeType":"range","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"ece4e0ed-dc73-49fd-aaa4-85fb0b1891b3","name":"Tensile strength","guid":"f5b64874-d68c-4b56-8403-d7405ff2b50f"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"ed116783-bb79-461b-b03b-80db875b001a","name":"Shape factor","guid":"d75ebc37-5b5a-4405-9f69-de52d775daf6"}],"displayNames":{"en":"Mechanical Properties English Display Name","fr":"Mechanical Properties French Display Name"},"name":"Mechanical Properties","guid":"aa6a7ef2-0e37-40a6-b3eb-11d502408281"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Create a new layout section.",
+ "operationId": "CreateSection",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"f17bcb6a-c0b1-4baa-aad7-6d1226b646bb"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"f17bcb6a-c0b1-4baa-aad7-6d1226b646bb"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"f17bcb6a-c0b1-4baa-aad7-6d1226b646bb"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateLayoutSection"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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": {"name":"Additional Properties (Guid)","guid":"f17bcb6a-c0b1-4baa-aad7-6d1226b646bb"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSlimLayoutSection"
+ },
+ "example": {"sectionDetailType":"slim","displayNames":{},"name":"Additional Properties","guid":"deeec7be-dbad-4150-8058-64b8958c7dc4"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Reorder the list of layout sections for a layout.",
+ "operationId": "ReorderSections",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaReorderSectionsInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "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"}]}
+ }
+ }
+ },
+ "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}": {
+ "get": {
+ "tags": [
+ "Schema - Layout Sections"
+ ],
+ "summary": "Get a layout section with a specified guid for a given layout.",
+ "operationId": "GetLayoutSection",
+ "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"
+ }
+ },
+ {
+ "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/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":"01e467ed-0253-4b13-8b9c-bc3cd54a7643"}
+ },
+ "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":[{"itemType":"attribute","attributeType":"shortText","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"a9db5718-591f-4638-a077-04ec5dc0994d","name":"Form","guid":"5990a7b4-3898-45d0-a60c-155eb796c645"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[{"itemType":"attribute","attributeType":"longText","required":true,"readOnly":false,"underlyingEntityGuid":"2c29d9b5-1c90-4e20-a495-5b8fbcccb240","name":"Sources","guid":"1447c88b-72c6-4eb5-8fb4-f6f6eb79bc90"},{"itemType":"attribute","attributeType":"shortText","required":true,"readOnly":false,"underlyingEntityGuid":"b59a6729-c0d9-4da4-826a-36e596836c96","name":"Notes","guid":"6f3a6ee2-48a2-4782-8ff2-bfa3ff877502"}],"underlyingEntityGuid":"83a5e12c-5bac-445b-926d-b68e67189a70","name":"Chemical resistance","guid":"3e6ca363-3ad9-413a-8888-7045a471c637"},{"itemType":"link","linkType":"recordLink","targetDatabase":"860d3540-b9a5-43d5-a493-08e9fc5473a1","targetDatabaseVersion":"a44e37a5-dcbe-4c64-95de-6280f8df3179","targetTable":"8650cc2c-4ac6-4ed9-9dc6-2d1142e30590","forwards":true,"underlyingEntityGuid":"fbec382d-5b4f-4c27-9fa9-b7152e68d932","name":"Material Pedigree","guid":"ca5f1840-2463-4bff-9fdb-87a6a0aa4c1b"},{"itemType":"attribute","attributeType":"link","required":false,"readOnly":false,"metaAttributes":[],"tabularColumns":[{"columnType":"linkedAttribute","tabularColumnGuid":"83349564-f1a5-47e5-a7f3-a6b26958da8f","name":"Offset Yield Stress","guid":"f5da40f9-51f4-4ac9-a290-9c5ee5d23285"},{"columnType":"localShortText","tabularColumnGuid":"04aa19e7-f444-45b3-9597-e07d4ccc83b7","name":"Young's Modulus Notes","guid":"a926b86c-39d5-46e8-a676-d1d4510eb628"}],"underlyingEntityGuid":"7352bc2f-83ad-4531-b540-81929e42c149","name":"Reference Characteristics","guid":"3d9a4611-be42-4592-9421-865d1cfb9e35"},{"itemType":"link","linkType":"associationChain","targetDatabase":"860d3540-b9a5-43d5-a493-08e9fc5473a1","targetDatabaseVersion":"a44e37a5-dcbe-4c64-95de-6280f8df3179","targetTable":"d022aa74-92a8-488b-817c-d8460344e27e","forwards":true,"nextLink":{"itemType":"link","linkType":"associationChain","targetDatabase":"860d3540-b9a5-43d5-a493-08e9fc5473a1","targetDatabaseVersion":"a44e37a5-dcbe-4c64-95de-6280f8df3179","targetTable":"1561f068-74ad-4989-9212-70eae0864721","forwards":false,"underlyingEntityGuid":"7939bc77-ad17-4887-82cb-8287ab63d508","name":"Pedigree information","guid":"fff0dc53-e0b1-4ae3-aa0a-6fd9c0ba040e"},"underlyingEntityGuid":"db800ea6-453a-4bf1-9cd7-3ed9ab7010fa","name":"To Pedigree from Producers","guid":"edc4b4e4-c58a-417a-97a1-7302977b2671"}],"displayNames":{"de":"Testing Information German Display Name","fr":"Testing Information French Display Name"},"name":"Testing Information","guid":"f233b0df-1712-4e4a-9f94-979186a628b8"}
+ }
+ }
+ }
+ }
+ },
+ "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, table, layout or layout 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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"7ba3a77e-74e2-4266-8a03-82e7ca3c81c5","sourceTableGuid":"9de97d84-f5a8-4cc2-85fc-62d70a3b92b4","linkGroupGuid":"e713cbb9-b1d3-4a95-b747-e33562b8d504"}
+ },
+ "Example 16": {
+ "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":"0605af53-a71f-4637-84c6-5dd0d2930d6c","tabularAttributeGuid":"a3eaa0af-fc94-4826-a9dc-4dcb875d1fba"},{"forwards":false,"sourceDatabaseVersionGuid":"a42cf10b-17a3-482e-8f32-8d8a2a73b229","tabularAttributeGuid":"e5f9a242-527c-4e3d-9c0c-52b8378e0251"}]}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"7ba3a77e-74e2-4266-8a03-82e7ca3c81c5","sourceTableGuid":"9de97d84-f5a8-4cc2-85fc-62d70a3b92b4","linkGroupGuid":"e713cbb9-b1d3-4a95-b747-e33562b8d504"}
+ },
+ "Example 16": {
+ "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":"0605af53-a71f-4637-84c6-5dd0d2930d6c","tabularAttributeGuid":"a3eaa0af-fc94-4826-a9dc-4dcb875d1fba"},{"forwards":false,"sourceDatabaseVersionGuid":"a42cf10b-17a3-482e-8f32-8d8a2a73b229","tabularAttributeGuid":"e5f9a242-527c-4e3d-9c0c-52b8378e0251"}]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"7ba3a77e-74e2-4266-8a03-82e7ca3c81c5","sourceTableGuid":"9de97d84-f5a8-4cc2-85fc-62d70a3b92b4","linkGroupGuid":"e713cbb9-b1d3-4a95-b747-e33562b8d504"}
+ },
+ "Example 16": {
+ "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":"0605af53-a71f-4637-84c6-5dd0d2930d6c","tabularAttributeGuid":"a3eaa0af-fc94-4826-a9dc-4dcb875d1fba"},{"forwards":false,"sourceDatabaseVersionGuid":"a42cf10b-17a3-482e-8f32-8d8a2a73b229","tabularAttributeGuid":"e5f9a242-527c-4e3d-9c0c-52b8378e0251"}]}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ "examples": {
+ "Example 9": {
+ "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 10": {
+ "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}
+ },
+ "Example 11": {
+ "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": {"itemType":"attribute","attributeGuid":"000000ec-0001-4fff-8fff-dd92ffff0000","metaAttributes":[{"itemType":"attribute","attributeGuid":"3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5","required":false,"readOnly":false}]}
+ },
+ "Example 12": {
+ "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 13": {
+ "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 14": {
+ "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 15": {
+ "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":"7ba3a77e-74e2-4266-8a03-82e7ca3c81c5","sourceTableGuid":"9de97d84-f5a8-4cc2-85fc-62d70a3b92b4","linkGroupGuid":"e713cbb9-b1d3-4a95-b747-e33562b8d504"}
+ },
+ "Example 16": {
+ "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":"0605af53-a71f-4637-84c6-5dd0d2930d6c","tabularAttributeGuid":"a3eaa0af-fc94-4826-a9dc-4dcb875d1fba"},{"forwards":false,"sourceDatabaseVersionGuid":"a42cf10b-17a3-482e-8f32-8d8a2a73b229","tabularAttributeGuid":"e5f9a242-527c-4e3d-9c0c-52b8378e0251"}]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ "examples": {
+ "Example 8": {
+ "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":"418d8bd7-2355-496a-9d82-9b4c60ccc904"}
+ },
+ "Example 9": {
+ "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":"1bf9d93f-fc13-4759-93cd-84182104df2a"}
+ },
+ "Example 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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":"52cd816b-f769-47f7-8da9-84a876c096e8","sourceTableGuid":"d255a447-9e1b-4c66-b2b5-166009c7f8b6","linkGroupGuid":"28e94e18-7160-4fea-a250-e0508b7467b4","guid":null}
+ },
+ "Example 14": {
+ "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":"9db59077-38ad-4600-bee4-69c431c26b05"},{"forwards":false,"sourceDatabaseVersionGuid":"00000000-0000-0000-0000-000000000000","tabularAttributeGuid":"32a90ec5-6e96-432e-afc3-542b09b929e8"}],"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",
+ "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"
+ }
+ },
+ {
+ "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}/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/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 table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Create a new layout.",
+ "operationId": "CreateLayout",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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":"Composite materials (guid)","guid":"dd6b6cab-6f6d-405d-9703-afb7ec0cb388"}
+ },
+ "Example 6": {
+ "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/GsaCreateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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":"Composite materials (guid)","guid":"dd6b6cab-6f6d-405d-9703-afb7ec0cb388"}
+ },
+ "Example 6": {
+ "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/GsaCreateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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":"Composite materials (guid)","guid":"dd6b6cab-6f6d-405d-9703-afb7ec0cb388"}
+ },
+ "Example 6": {
+ "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/GsaCreateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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":"Composite materials (guid)","guid":"dd6b6cab-6f6d-405d-9703-afb7ec0cb388"}
+ },
+ "Example 6": {
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaLayout"
+ },
+ "example": {"applicableApplications":[],"displayNames":{},"name":"Ceramics","guid":"81434f48-6834-4f85-873e-d252d24b6dd1"}
+ }
+ }
+ },
+ "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",
+ "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/GsaLayout"
+ },
+ "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":"18418699-4633-4485-8ab3-d3554b3c3de8","name":"Price","guid":"9cd1ce42-f0cf-4389-9edc-f1fd066195b9"},{"itemType":"attribute","attributeType":"point","required":false,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"93a891e1-f48a-472c-9e21-31d618bd06df","name":"Density","guid":"00c61ed5-d4fe-4442-8545-b36c041a1da1"}],"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":"70e9bbda-1806-4901-bcc6-d6e934d32835","name":"Young's modulus","guid":"03d40f47-8f56-4034-9bde-6e4417e42046"},{"itemType":"attribute","attributeType":"range","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"ce1ec392-92fc-4db8-98ba-7989d5c1a1d3","name":"Tensile strength","guid":"72b52ea6-db0a-4eb9-a2df-2f08692b80f7"},{"itemType":"attribute","attributeType":"point","required":true,"readOnly":false,"metaAttributes":[],"underlyingEntityGuid":"b023c9dd-adc0-4d84-8485-3105643c1ac7","name":"Shape factor","guid":"331e2611-a773-45c2-938e-6d06eb656081"}],"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"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Update a layout.",
+ "operationId": "UpdateLayout",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"applicableApplications":["MI:Explore","An Application"],"name":"Ceramics (Updated)","guid":"607ea43e-f016-4844-bbd2-dab3d9d490d1"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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/GsaUpdateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"applicableApplications":["MI:Explore","An Application"],"name":"Ceramics (Updated)","guid":"607ea43e-f016-4844-bbd2-dab3d9d490d1"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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/GsaUpdateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"applicableApplications":["MI:Explore","An Application"],"name":"Ceramics (Updated)","guid":"607ea43e-f016-4844-bbd2-dab3d9d490d1"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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/GsaUpdateLayout"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"applicableApplications":["MI:Explore","An Application"],"name":"Ceramics (Updated)","guid":"607ea43e-f016-4844-bbd2-dab3d9d490d1"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaLayout"
+ },
+ "example": {"applicableApplications":[],"displayNames":{},"name":"Ceramics","guid":"6c56da5c-c8f2-4520-bdbc-7b5fe1d5baba"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Database, table or layout not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Layouts"
+ ],
+ "summary": "Delete a layout.",
+ "operationId": "DeleteLayout",
+ "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"
+ }
+ }
+ ],
+ "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: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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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}/parameters": {
+ "get": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Get all parameters for a given database.",
+ "operationId": "GetParameters",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaParametersInfo"
+ },
+ "examples": {
+ "Example 2": {
+ "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"}]}
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Create a new parameter.",
+ "operationId": "CreateParameter",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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":"c030692a-87e9-408c-8c7a-3054552aa357"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"660e78de-c3e3-44a3-b14b-ce0b052f8bec"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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 6": {
+ "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 7": {
+ "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":"c030692a-87e9-408c-8c7a-3054552aa357"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"660e78de-c3e3-44a3-b14b-ce0b052f8bec"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateParameter"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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":"c030692a-87e9-408c-8c7a-3054552aa357"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"660e78de-c3e3-44a3-b14b-ce0b052f8bec"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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 6": {
+ "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 7": {
+ "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":"c030692a-87e9-408c-8c7a-3054552aa357"},{"type":"discrete","name":"Green"}],"type":"discrete","defaultParameterValueIndex":1,"name":"Color (guid)","guid":"660e78de-c3e3-44a3-b14b-ce0b052f8bec"}
+ },
+ "Example 8": {
+ "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 9": {
+ "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 10": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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,"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"
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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,"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"}
+ }
+ }
+ },
+ "404": {
+ "description": "Database or parameter not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Parameters"
+ ],
+ "summary": "Update a parameter.",
+ "operationId": "UpdateParameter",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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 8": {
+ "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": {"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":"44870543-7137-46dc-b391-5e65956ea4e8"}
+ },
+ "Example 9": {
+ "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":"fb14855b-bc04-4922-ad3d-45f858b7b237"}
+ },
+ "Example 10": {
+ "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":"ef507022-235d-4ac0-8377-59a3e1b3b603"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"deac0f81-0eb7-4937-bad6-45f77e7317c6"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GsaUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"44870543-7137-46dc-b391-5e65956ea4e8"}
+ },
+ "Example 9": {
+ "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":"fb14855b-bc04-4922-ad3d-45f858b7b237"}
+ },
+ "Example 10": {
+ "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":"ef507022-235d-4ac0-8377-59a3e1b3b603"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"deac0f81-0eb7-4937-bad6-45f77e7317c6"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GsaUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"44870543-7137-46dc-b391-5e65956ea4e8"}
+ },
+ "Example 9": {
+ "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":"fb14855b-bc04-4922-ad3d-45f858b7b237"}
+ },
+ "Example 10": {
+ "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":"ef507022-235d-4ac0-8377-59a3e1b3b603"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"deac0f81-0eb7-4937-bad6-45f77e7317c6"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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/GsaUpdateParameter"
+ },
+ "examples": {
+ "Example 8": {
+ "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": {"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":"44870543-7137-46dc-b391-5e65956ea4e8"}
+ },
+ "Example 9": {
+ "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":"fb14855b-bc04-4922-ad3d-45f858b7b237"}
+ },
+ "Example 10": {
+ "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":"ef507022-235d-4ac0-8377-59a3e1b3b603"}
+ },
+ "Example 11": {
+ "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 12": {
+ "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":"deac0f81-0eb7-4937-bad6-45f77e7317c6"}
+ },
+ "Example 13": {
+ "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 14": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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,"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"
+ },
+ "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": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaParameterDeletionException"
+ },
+ "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":[{"type":"floatFunctional","isHiddenFromSearchCriteria":false,"table":{"guid":"0000dd92-0011-4fff-8fff-0000ffff0000"},"name":"Tensile strength with temperature","guid":"00000002-0001-4fff-8fff-dd92ffff0000"}]}]}
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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,"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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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 4": {
+ "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":"2fff3b5f-7ebe-43ff-86b2-f187e66c34d1"}
+ },
+ "Example 5": {
+ "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":"8881a4b4-0465-46e3-a5a8-57f63610d2e4"}
+ },
+ "Example 6": {
+ "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":"cd7b2b6a-a2a8-4524-bc45-dffb8419a133"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"2fff3b5f-7ebe-43ff-86b2-f187e66c34d1"}
+ },
+ "Example 5": {
+ "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":"8881a4b4-0465-46e3-a5a8-57f63610d2e4"}
+ },
+ "Example 6": {
+ "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":"cd7b2b6a-a2a8-4524-bc45-dffb8419a133"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"2fff3b5f-7ebe-43ff-86b2-f187e66c34d1"}
+ },
+ "Example 5": {
+ "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":"8881a4b4-0465-46e3-a5a8-57f63610d2e4"}
+ },
+ "Example 6": {
+ "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":"cd7b2b6a-a2a8-4524-bc45-dffb8419a133"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateParameterValue"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"2fff3b5f-7ebe-43ff-86b2-f187e66c34d1"}
+ },
+ "Example 5": {
+ "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":"8881a4b4-0465-46e3-a5a8-57f63610d2e4"}
+ },
+ "Example 6": {
+ "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":"cd7b2b6a-a2a8-4524-bc45-dffb8419a133"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaParameterValue"
+ },
+ "example": {"type":"numeric","value":0.1,"guid":"173284fb-e557-406f-a7eb-f4e75f1d48a9"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Parameter in use."
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1').","code":400,"errors":[{"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"}]}]}
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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 3": {
+ "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 4": {
+ "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/GsaCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GsaCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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/GsaCreateParameterValue"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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,"guid":"173284fb-e557-406f-a7eb-f4e75f1d48a9"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request. Parameter in use."
+ },
+ "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"},{"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 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GsaUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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"}}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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/GsaUpdateAllProfilesInfo"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "summary": "Remove default profile",
+ "description": "This example demonstrates how to remove default profile by setting it to null",
+ "value": {"defaultProfile":null}
+ },
+ "Example 7": {
+ "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 8": {
+ "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": {
+ "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"},{"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"
+ },
+ "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 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"a630b6a2-abef-4241-af7b-1ed56b600394"}
+ },
+ "Example 6": {
+ "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":"88ade83c-4be8-4b2d-82b9-ce05550e4da1"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"a630b6a2-abef-4241-af7b-1ed56b600394"}
+ },
+ "Example 6": {
+ "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":"88ade83c-4be8-4b2d-82b9-ce05550e4da1"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"a630b6a2-abef-4241-af7b-1ed56b600394"}
+ },
+ "Example 6": {
+ "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":"88ade83c-4be8-4b2d-82b9-ce05550e4da1"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Profile",
+ "description": "This example demonstrates how to create a new profile",
+ "value": {"name":"MI:Training Processes"}
+ },
+ "Example 5": {
+ "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":"a630b6a2-abef-4241-af7b-1ed56b600394"}
+ },
+ "Example 6": {
+ "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":"88ade83c-4be8-4b2d-82b9-ce05550e4da1"}
+ }
+ }
+ }
+ }
+ },
+ "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"}
+ }
+ }
+ },
+ "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"
+ },
+ "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 4": {
+ "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":"db99acc1-de12-4c0b-aa08-fdc4c4b6c8ff"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"80245f8c-3f6c-49a8-b6b3-d7114f7cf56b","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"db99acc1-de12-4c0b-aa08-fdc4c4b6c8ff"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"80245f8c-3f6c-49a8-b6b3-d7114f7cf56b","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"db99acc1-de12-4c0b-aa08-fdc4c4b6c8ff"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"80245f8c-3f6c-49a8-b6b3-d7114f7cf56b","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateProfile"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"db99acc1-de12-4c0b-aa08-fdc4c4b6c8ff"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"80245f8c-3f6c-49a8-b6b3-d7114f7cf56b","groupName":"MI:Training Profiles (Updated)","name":"MI:Training Metals"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "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"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Profile not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Profiles"
+ ],
+ "summary": "Delete a profile",
+ "operationId": "DeleteProfile",
+ "parameters": [
+ {
+ "name": "profile-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "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,
+ "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"}]}
+ }
+ }
+ },
+ "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,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"e5ac3fbe-0e22-4f7e-ad95-74f3196cc89d"}
+ },
+ "Example 6": {
+ "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": {"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":"fb2f092f-0cee-4d3a-b7e0-b42a7f95ffa1"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"e5ac3fbe-0e22-4f7e-ad95-74f3196cc89d"}
+ },
+ "Example 6": {
+ "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": {"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":"fb2f092f-0cee-4d3a-b7e0-b42a7f95ffa1"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"e5ac3fbe-0e22-4f7e-ad95-74f3196cc89d"}
+ },
+ "Example 6": {
+ "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": {"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":"fb2f092f-0cee-4d3a-b7e0-b42a7f95ffa1"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e"}
+ },
+ "Example 5": {
+ "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": {"databaseGuid":"43a43640-4919-428a-bac9-16efbc4ce6ed","tableGuid":"bc666ac6-8ac6-482b-9a16-502e6ab3730e","guid":"e5ac3fbe-0e22-4f7e-ad95-74f3196cc89d"}
+ },
+ "Example 6": {
+ "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": {"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":"fb2f092f-0cee-4d3a-b7e0-b42a7f95ffa1"}
+ }
+ }
+ }
+ }
+ },
+ "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": {"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 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"9fb9122b-793a-425d-91fd-07ca11a0dfb6"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"5525543e-557a-4b18-beaa-a892b64550f3"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"9fb9122b-793a-425d-91fd-07ca11a0dfb6"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"5525543e-557a-4b18-beaa-a892b64550f3"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"9fb9122b-793a-425d-91fd-07ca11a0dfb6"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"5525543e-557a-4b18-beaa-a892b64550f3"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateProfileTable"
+ },
+ "examples": {
+ "Example 4": {
+ "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": {"subsetGuid":"00000b36-0010-4fff-8fff-dd92ffff0000","layoutGuid":"00000b36-0009-4fff-8fff-dd92ffff0000","guid":"9fb9122b-793a-425d-91fd-07ca11a0dfb6"}
+ },
+ "Example 5": {
+ "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": {"subsetGuid":null,"layoutGuid":null}
+ },
+ "Example 6": {
+ "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":"5525543e-557a-4b18-beaa-a892b64550f3"}
+ }
+ }
+ }
+ }
+ },
+ "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}/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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRecordLinkGroupsInfo"
+ },
+ "example": {"recordLinkGroups":[{"identity":115,"type":"static","reverseName":"Training Exercise","reverseDisplayNames":{},"displayNames":{},"name":"MaterialUniverse","guid":"00e07ec0-695e-4ca3-bf1d-3bbeef126949"},{"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"},"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":"d3ef7890-26e9-4aaa-80d9-92b84e709634"}]}
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"645a0331-351e-43d1-882f-b7c1c76ad96e"}
+ },
+ "Example 9": {
+ "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":"c4719922-9787-408f-aa68-0cc333dca061"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"b5341849-ac08-4d1a-b05c-52453e01aaa6","tableGuid":"e01c8e9a-fb46-4025-aa85-b8309df3e1e1"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"e53aea91-6216-4414-a4a9-1fb454a51edd"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"3de759dc-caea-4116-bc17-5e75dbd04b56"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"645a0331-351e-43d1-882f-b7c1c76ad96e"}
+ },
+ "Example 9": {
+ "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":"c4719922-9787-408f-aa68-0cc333dca061"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"b5341849-ac08-4d1a-b05c-52453e01aaa6","tableGuid":"e01c8e9a-fb46-4025-aa85-b8309df3e1e1"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"e53aea91-6216-4414-a4a9-1fb454a51edd"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"3de759dc-caea-4116-bc17-5e75dbd04b56"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"645a0331-351e-43d1-882f-b7c1c76ad96e"}
+ },
+ "Example 9": {
+ "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":"c4719922-9787-408f-aa68-0cc333dca061"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"b5341849-ac08-4d1a-b05c-52453e01aaa6","tableGuid":"e01c8e9a-fb46-4025-aa85-b8309df3e1e1"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"e53aea91-6216-4414-a4a9-1fb454a51edd"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"3de759dc-caea-4116-bc17-5e75dbd04b56"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 7": {
+ "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 8": {
+ "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":"645a0331-351e-43d1-882f-b7c1c76ad96e"}
+ },
+ "Example 9": {
+ "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":"c4719922-9787-408f-aa68-0cc333dca061"},"reverseName":"Cross database link to Material Universe","name":"Cross database link from Material Universe"}
+ },
+ "Example 10": {
+ "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":"b5341849-ac08-4d1a-b05c-52453e01aaa6","tableGuid":"e01c8e9a-fb46-4025-aa85-b8309df3e1e1"},"reverseName":"Cross database link to MI Training - Material Universe","name":"Cross database link from MI Training - Material Universe","guid":"e53aea91-6216-4414-a4a9-1fb454a51edd"}
+ },
+ "Example 11": {
+ "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":[{"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 12": {
+ "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": {"type":"dynamic","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"}],"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":"3de759dc-caea-4116-bc17-5e75dbd04b56"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRecordLinkGroup"
+ },
+ "examples": {
+ "Example 13": {
+ "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"}},"identity":125,"reverseName":"Fatigue Statistical Data","reverseDisplayNames":{},"displayNames":{},"name":"Fatigue Test Data","guid":"485da78d-d094-4edb-a5a9-077fe1bc02f2"}
+ },
+ "Example 14": {
+ "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"},"linkTarget":{"databaseGuid":"1790e7ba-f601-46c0-bbc9-28a75f1c1730","tableGuid":"dc59488b-bfb4-403d-89e9-a419caa77e91"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"980c0ee2-7a82-4dec-86bf-f6ee576c8e0d"}
+ },
+ "Example 15": {
+ "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":[{"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"}}],"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 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",
+ "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": "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/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"}},"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"},"linkTarget":{"databaseGuid":"e69b304d-493c-4592-9519-614dcdcd65ed","tableGuid":"f8d70118-a308-48ca-926f-842b3ff0c02c"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"7f2737e2-ba4a-48db-a9db-03209b746a61"}
+ },
+ "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": {"type":"dynamic","forbidOrphans":false,"referentialIntegrityModel":"oneToMany","attributePairs":[{"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"}}],"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",
+ "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"
+ }
+ }
+ ],
+ "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",
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"fa69addb-b99d-47f1-9674-584c2d275bae"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"d9517073-4e7e-491f-814b-15f41ff7ad79"}
+ },
+ "Example 9": {
+ "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":"40ec8bd1-fc94-4c03-b8b1-2a445193632b"}
+ },
+ "Example 10": {
+ "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":"9e24bc56-2673-4f85-a875-b7dbf8491167"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"fa69addb-b99d-47f1-9674-584c2d275bae"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"d9517073-4e7e-491f-814b-15f41ff7ad79"}
+ },
+ "Example 9": {
+ "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":"40ec8bd1-fc94-4c03-b8b1-2a445193632b"}
+ },
+ "Example 10": {
+ "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":"9e24bc56-2673-4f85-a875-b7dbf8491167"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"fa69addb-b99d-47f1-9674-584c2d275bae"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"d9517073-4e7e-491f-814b-15f41ff7ad79"}
+ },
+ "Example 9": {
+ "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":"40ec8bd1-fc94-4c03-b8b1-2a445193632b"}
+ },
+ "Example 10": {
+ "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":"9e24bc56-2673-4f85-a875-b7dbf8491167"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup"
+ },
+ "examples": {
+ "Example 6": {
+ "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":"fa69addb-b99d-47f1-9674-584c2d275bae"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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":"d9517073-4e7e-491f-814b-15f41ff7ad79"}
+ },
+ "Example 9": {
+ "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":"40ec8bd1-fc94-4c03-b8b1-2a445193632b"}
+ },
+ "Example 10": {
+ "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":"9e24bc56-2673-4f85-a875-b7dbf8491167"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRecordLinkGroup"
+ },
+ "examples": {
+ "Example 16": {
+ "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"}},"identity":125,"reverseName":"Fatigue Statistical Data","reverseDisplayNames":{},"displayNames":{},"name":"Fatigue Test Data","guid":"485da78d-d094-4edb-a5a9-077fe1bc02f2"}
+ },
+ "Example 17": {
+ "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"},"linkTarget":{"databaseGuid":"909ea665-312d-4295-b28a-3de9446b974e","tableGuid":"151a141f-d8f6-4bb5-9423-e177c96894e8"}},"identity":1,"reverseName":"MI Training - MaterialUniverse","reverseDisplayNames":{},"displayNames":{},"name":"Different database - different table","guid":"b50ec680-bd7e-4b7f-88ae-46ecbfb9dcf0"}
+ },
+ "Example 18": {
+ "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":[{"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"}}],"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 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"
+ }
+ }
+ ],
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Replacement string to add to database",
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateReplacementString"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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":"284635e7-44e6-42a2-afa5-22319bc1e493"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateReplacementString"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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":"284635e7-44e6-42a2-afa5-22319bc1e493"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateReplacementString"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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":"284635e7-44e6-42a2-afa5-22319bc1e493"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateReplacementString"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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":"284635e7-44e6-42a2-afa5-22319bc1e493"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "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 4": {
+ "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": {"value":"New value for replacement string","name":"New name for replacement string","guid":"6b7cf1de-010a-48ba-9a0b-001a4a33f1c3"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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 4": {
+ "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": {"value":"New value for replacement string","name":"New name for replacement string","guid":"6b7cf1de-010a-48ba-9a0b-001a4a33f1c3"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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 4": {
+ "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": {"value":"New value for replacement string","name":"New name for replacement string","guid":"6b7cf1de-010a-48ba-9a0b-001a4a33f1c3"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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 4": {
+ "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": {"value":"New value for replacement string","name":"New name for replacement string","guid":"6b7cf1de-010a-48ba-9a0b-001a4a33f1c3"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ {
+ "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}/standard-names": {
+ "get": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Gets all standard names for a given database.",
+ "operationId": "GetStandardNames",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaStandardNamesInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Create a new standard name",
+ "operationId": "CreateStandardName",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateStandardName"
+ },
+ "examples": {
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"edb0b7df-05fd-4cd7-933c-e0fae6cac7da"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"edb0b7df-05fd-4cd7-933c-e0fae6cac7da"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"edb0b7df-05fd-4cd7-933c-e0fae6cac7da"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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 6": {
+ "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 7": {
+ "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 8": {
+ "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 9": {
+ "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":"edb0b7df-05fd-4cd7-933c-e0fae6cac7da"}],"name":"Unification"}
+ },
+ "Example 10": {
+ "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"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaStandardName"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "standard-name-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaStandardName"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or standard name not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Edit a standard name",
+ "operationId": "UpdateStandardName",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "standard-name-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateStandardName"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"24853c23-5e82-426f-9c3d-85f641a5bc23"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"24853c23-5e82-426f-9c3d-85f641a5bc23"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"24853c23-5e82-426f-9c3d-85f641a5bc23"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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"
+ },
+ "examples": {
+ "Example 5": {
+ "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 6": {
+ "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":"24853c23-5e82-426f-9c3d-85f641a5bc23"}
+ },
+ "Example 7": {
+ "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 8": {
+ "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 standard name not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Standard Names"
+ ],
+ "summary": "Delete a standard name.",
+ "operationId": "DeleteStandardName",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": "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": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSubsetsInfo"
+ },
+ "example": {"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 or table not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Subsets"
+ ],
+ "summary": "Create a new subset.",
+ "operationId": "CreateSubset",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"8e829c97-d938-4783-a6f6-e4aebfaf14c2"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"8e829c97-d938-4783-a6f6-e4aebfaf14c2"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"8e829c97-d938-4783-a6f6-e4aebfaf14c2"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateSubset"
+ },
+ "examples": {
+ "Example 4": {
+ "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"}
+ },
+ "Example 5": {
+ "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": {"name":"Alloys (guid)","guid":"8e829c97-d938-4783-a6f6-e4aebfaf14c2"}
+ },
+ "Example 6": {
+ "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": {"associatedLayout":{"guid":"00000b36-0009-4fff-8fff-dd92ffff0000"},"name":"Alloys (Layout)"}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "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",
+ "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/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",
+ "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",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateSubset"
+ },
+ "examples": {
+ "Example 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"97b97f83-ce2c-4cbc-93f1-ba65faa9e999"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"97b97f83-ce2c-4cbc-93f1-ba65faa9e999"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"97b97f83-ce2c-4cbc-93f1-ba65faa9e999"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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 5": {
+ "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": {"associatedLayout":{"guid":"0000b135-0009-4fff-8fff-dd92ffff0000"},"name":"Ceramics (Updated)","guid":"97b97f83-ce2c-4cbc-93f1-ba65faa9e999"}
+ },
+ "Example 6": {
+ "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 7": {
+ "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 8": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "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"}
+ }
+ }
+ },
+ "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",
+ "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",
+ "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",
+ "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",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset"
+ },
+ "examples": {
+ "Example 3": {
+ "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 4": {
+ "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 3": {
+ "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 4": {
+ "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 3": {
+ "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 4": {
+ "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 3": {
+ "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 4": {
+ "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, 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",
+ "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",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"recordHistoryGuid":"5a842e54-e143-45f5-aec8-18fb84f4fe03"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"recordHistoryGuid":"5a842e54-e143-45f5-aec8-18fb84f4fe03"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"recordHistoryGuid":"5a842e54-e143-45f5-aec8-18fb84f4fe03"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset"
+ },
+ "examples": {
+ "Example 2": {
+ "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": {"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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaTablesInfo"
+ },
+ "example": {"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 not found"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Create a new table.",
+ "operationId": "CreateTable",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"299f90d8-a9be-4870-ac40-384c74dbf094"}
+ },
+ "Example 6": {
+ "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/GsaCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"299f90d8-a9be-4870-ac40-384c74dbf094"}
+ },
+ "Example 6": {
+ "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)"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"299f90d8-a9be-4870-ac40-384c74dbf094"}
+ },
+ "Example 6": {
+ "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/GsaCreateTable"
+ },
+ "examples": {
+ "Example 4": {
+ "summary": "Table",
+ "description": "This example demonstrates how to create a new table in the MI_Training database.",
+ "value": {"isHiddenFromBrowse":false,"isHiddenFromSearch":false,"name":"Coatings"}
+ },
+ "Example 5": {
+ "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":"299f90d8-a9be-4870-ac40-384c74dbf094"}
+ },
+ "Example 6": {
+ "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)"}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaTable"
+ },
+ "example": {"versionState":"unversioned","isHiddenFromBrowse":false,"isHiddenFromSearch":false,"isVersioned":false,"tableTypes":[],"displayNames":{},"name":"Material Universe","guid":"0000dd92-0011-4fff-8fff-0000ffff0000"}
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "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"
+ }
+ }
+ ],
+ "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","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 table not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Update a table.",
+ "operationId": "UpdateTable",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"564b834e-4577-40df-953d-47dd33292641"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GsaUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"564b834e-4577-40df-953d-47dd33292641"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GsaUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"564b834e-4577-40df-953d-47dd33292641"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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/GsaUpdateTable"
+ },
+ "examples": {
+ "Example 8": {
+ "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","name":"MaterialUniverse (Updated)","guid":"564b834e-4577-40df-953d-47dd33292641"}
+ },
+ "Example 9": {
+ "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 10": {
+ "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 11": {
+ "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 12": {
+ "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 13": {
+ "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 14": {
+ "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}
+ }
+ }
+ }
+ }
+ },
+ "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","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 table not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Schema - Tables"
+ ],
+ "summary": "Delete a table.",
+ "operationId": "DeleteTable",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Bad request. Table in use.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaTableDeletionException"
+ },
+ "example": {"message":"Cannot delete table 'Restricted Substances' (GUID = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f').","code":400,"errors":[{"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 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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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":"released","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"
+ },
+ "examples": {
+ "Example 3": {
+ "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":400,"errors":[{"message":"Invalid version state 'Released'.","reason":"invalidVersionState","versionState":"released"}]}
+ },
+ "Example 4": {
+ "summary": "Table is not version controlled.",
+ "value": {"message":"Cannot release table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.","code":400,"errors":[{"message":"Table is not version controlled.","reason":"notVersioned"}]}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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","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.",
+ "operationId": "GetInboundLinks",
+ "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"
+ }
+ }
+ ],
+ "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":"b7ad4a56-937d-4ccf-99e1-a76531958752","databaseVersionGuid":"936fe75f-4e8d-4625-b39a-ecc45fd0afa9","tableGuid":"7eae55ef-0e68-4573-890a-16c33d15413a"},"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":"645f966c-db9c-4f2f-bb13-1ac314787dd8"},{"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}/units/{unit-guid}/equivalent-units": {
+ "get": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Get equivalent units (one per unit system)",
+ "operationId": "GetUnitEquivalents",
+ "parameters": [
+ {
+ "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUnitEquivalentsInfo"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ }
+ },
+ "/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 - Units"
+ ],
+ "summary": "Set the equivalent unit for a given unit system",
+ "operationId": "SetUnitEquivalent",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "unit-system-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "equivalent-unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "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/GsaCreateUnit"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateUnit"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateUnit"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateUnit"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUnit"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUnit"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit not found"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Schema - Units"
+ ],
+ "summary": "Update unit.",
+ "operationId": "UpdateUnit",
+ "parameters": [
+ {
+ "name": "database-key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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": "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": "unit-guid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "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": "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",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUnitUsage"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Database or unit 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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"b3c0ba65-413d-49a2-93c0-3a4a212c2729"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"b3c0ba65-413d-49a2-93c0-3a4a212c2729"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"b3c0ba65-413d-49a2-93c0-3a4a212c2729"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateUnitSystem"
+ },
+ "examples": {
+ "Example 2": {
+ "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":"Hawaiian common","guid":"b3c0ba65-413d-49a2-93c0-3a4a212c2729"}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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 4": {
+ "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":"27d73173-9899-4e68-99aa-975a71e9f126"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"bbcb61c8-68f0-457c-88e3-5d4af3f6c4f5"}
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"27d73173-9899-4e68-99aa-975a71e9f126"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"bbcb61c8-68f0-457c-88e3-5d4af3f6c4f5"}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"27d73173-9899-4e68-99aa-975a71e9f126"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"bbcb61c8-68f0-457c-88e3-5d4af3f6c4f5"}
+ }
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaUpdateUnitSystem"
+ },
+ "examples": {
+ "Example 4": {
+ "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":"27d73173-9899-4e68-99aa-975a71e9f126"}
+ },
+ "Example 5": {
+ "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 6": {
+ "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":"bbcb61c8-68f0-457c-88e3-5d4af3f6c4f5"}
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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/{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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "table-identity",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "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/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["e7e34c2f-a2d6-45df-800a-efc4b8c718ef","dfb427d6-ecbe-40a8-a020-ea13d2ee908a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["e7e34c2f-a2d6-45df-800a-efc4b8c718ef","dfb427d6-ecbe-40a8-a020-ea13d2ee908a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["e7e34c2f-a2d6-45df-800a-efc4b8c718ef","dfb427d6-ecbe-40a8-a020-ea13d2ee908a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["e7e34c2f-a2d6-45df-800a-efc4b8c718ef","dfb427d6-ecbe-40a8-a020-ea13d2ee908a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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",
+ "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/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["309a47e6-2340-433e-9f7b-1b408f44133a","196d8cb6-49c1-4a05-9771-65bc05cd3c5a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["309a47e6-2340-433e-9f7b-1b408f44133a","196d8cb6-49c1-4a05-9771-65bc05cd3c5a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["309a47e6-2340-433e-9f7b-1b408f44133a","196d8cb6-49c1-4a05-9771-65bc05cd3c5a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["309a47e6-2340-433e-9f7b-1b408f44133a","196d8cb6-49c1-4a05-9771-65bc05cd3c5a"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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",
+ "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/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["ee57668d-24fe-45e2-a188-f660b8f3c798","90fdbbdc-97ba-407f-aeed-e281befa06cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["ee57668d-24fe-45e2-a188-f660b8f3c798","90fdbbdc-97ba-407f-aeed-e281befa06cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["ee57668d-24fe-45e2-a188-f660b8f3c798","90fdbbdc-97ba-407f-aeed-e281befa06cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 59": {
+ "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"}]}
+ },
+ "Example 60": {
+ "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":[]}
+ },
+ "Example 61": {
+ "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 62": {
+ "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 63": {
+ "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"}]}
+ },
+ "Example 64": {
+ "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 65": {
+ "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":[]}
+ },
+ "Example 66": {
+ "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 67": {
+ "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":[]}
+ },
+ "Example 68": {
+ "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 69": {
+ "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 70": {
+ "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":["ee57668d-24fe-45e2-a188-f660b8f3c798","90fdbbdc-97ba-407f-aeed-e281befa06cb"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 71": {
+ "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 72": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 73": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 74": {
+ "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":[]}
+ },
+ "Example 75": {
+ "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":[]}
+ },
+ "Example 76": {
+ "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 77": {
+ "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 78": {
+ "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 79": {
+ "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 80": {
+ "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 81": {
+ "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 82": {
+ "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 83": {
+ "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 84": {
+ "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}}
+ },
+ "Example 85": {
+ "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 86": {
+ "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 87": {
+ "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":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["94e4a9f3-6a35-4f0c-92d8-fed5dd4d9f01","79917b1d-2a15-448a-b7b9-f8da176e72f3"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["94e4a9f3-6a35-4f0c-92d8-fed5dd4d9f01","79917b1d-2a15-448a-b7b9-f8da176e72f3"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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":[]}
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["94e4a9f3-6a35-4f0c-92d8-fed5dd4d9f01","79917b1d-2a15-448a-b7b9-f8da176e72f3"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchRequest"
+ },
+ "examples": {
+ "Example 88": {
+ "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"}]}
+ },
+ "Example 89": {
+ "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":[]}
+ },
+ "Example 90": {
+ "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 91": {
+ "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 92": {
+ "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"}]}
+ },
+ "Example 93": {
+ "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 94": {
+ "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":[]}
+ },
+ "Example 95": {
+ "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 96": {
+ "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":[]}
+ },
+ "Example 97": {
+ "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 98": {
+ "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 99": {
+ "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":["94e4a9f3-6a35-4f0c-92d8-fed5dd4d9f01","79917b1d-2a15-448a-b7b9-f8da176e72f3"],"type":"recordListMember"},"sortCriteria":[]}
+ },
+ "Example 100": {
+ "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 101": {
+ "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":{"ancestorIdentity":8923,"directParentOnly":false,"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 102": {
+ "summary": "Top level records search",
+ "description": "A search in MI_TRAINING for results where the record has no parent in the tree",
+ "value": {"criterion":{"type":"recordAncestor"},"sortCriteria":[]}
+ },
+ "Example 103": {
+ "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":[]}
+ },
+ "Example 104": {
+ "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":[]}
+ },
+ "Example 105": {
+ "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 106": {
+ "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 107": {
+ "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 108": {
+ "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 109": {
+ "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 110": {
+ "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 111": {
+ "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 112": {
+ "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 113": {
+ "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}}
+ },
+ "Example 114": {
+ "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 115": {
+ "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 116": {
+ "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":[]}
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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"
+ }
+ }
+ }
+ },
+ "/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/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"
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaCreateSearchRequest"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSelectionSearch"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSelectionSearch"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSelectionSearch"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ }
+ }
+ },
+ "/v1alpha/selection-searches/search/{searchIdentifier}": {
+ "get": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Returns the given search if it exists and the calling user has access to it",
+ "operationId": "GetSearch",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSelectionSearch"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "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"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json-patch+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSaveSearchRequest"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSaveSearchRequest"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSaveSearchRequest"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSaveSearchRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "400": {
+ "description": "Bad request"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Search not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SelectionSearches"
+ ],
+ "summary": "Delete an existing selection search.",
+ "operationId": "DeleteSearch",
+ "parameters": [
+ {
+ "name": "searchIdentifier",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Selection search not found"
+ }
+ }
+ }
+ },
+ "/v1alpha/status": {
+ "get": {
+ "tags": [
+ "Status"
+ ],
+ "summary": "Check whether the API is available",
+ "operationId": "Get",
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ }
+ },
+ "/v1alpha/status/databases": {
+ "get": {
+ "tags": [
+ "Status"
+ ],
+ "summary": "Returns status information for all databases",
+ "operationId": "GetStatus",
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "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": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchClusterStatus"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchClusterStatus"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GsaSearchClusterStatus"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "GsaAddDatabase": {
+ "required": [
+ "databaseKey",
+ "dataSource",
+ "initialCatalog"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "dataSource": {
+ "type": "string",
+ "description": "The SQL server data source"
+ },
+ "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 user name to use if the new database should use SQL authentication. The password must also be provided.",
+ "nullable": true
+ },
+ "sqlPassword": {
+ "type": "string",
+ "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
+ },
+ "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
+ },
+ "GsaAddRecordHistoryToSubset": {
+ "required": [
+ "recordHistoryGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recurseChildren": {
+ "type": "boolean"
+ }
+ },
+ "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\r\n * 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\r\n * 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\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"
+ }
+ }
+ },
+ "GsaAggregationDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterionType"
+ }
+ },
+ "additionalProperties": false,
+ "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": "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
+ }
+ },
+ "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."
+ },
+ "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."
+ },
+ "GsaAllValuesSpecifier": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaValueSpecifier"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "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"
+ },
+ "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\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"
+ },
+ "GsaApplicationsInfo": {
+ "type": "object",
+ "properties": {
+ "applications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaAttribute": {
+ "required": [
+ "defaultThresholdType",
+ "displayNames",
+ "guid",
+ "info",
+ "isHiddenFromSearchCriteria",
+ "name",
+ "table",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "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."
+ },
+ "table": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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\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"
+ },
+ "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\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\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'value'",
+ "x-discriminator-value": "value",
+ "x-discriminator-name": "attributeAggregationCriterionType"
+ },
+ "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\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"
+ },
+ "GsaAttributeCriterionType": {
+ "enum": [
+ "matches",
+ "exists",
+ "notApplicable"
+ ],
+ "type": "string"
+ },
+ "GsaAttributeDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "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\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\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\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"
+ }
+ },
+ "primaryDynamicLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "foreignDynamicLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaAttributeInterpolationMethod": {
+ "enum": [
+ "auto",
+ "none",
+ "linear",
+ "cubicSpline"
+ ],
+ "type": "string"
+ },
+ "GsaAttributeLinkPair": {
+ "type": "object",
+ "properties": {
+ "attributeSource": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ },
+ "attributeTarget": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ }
+ },
+ "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\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'matches'",
+ "x-discriminator-value": "matches",
+ "x-discriminator-name": "attributeCriterionType"
+ },
+ "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\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'notApplicable'",
+ "x-discriminator-value": "notApplicable",
+ "x-discriminator-name": "attributeCriterionType"
+ },
+ "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"
+ },
+ "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\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"
+ },
+ "GsaAttributeThresholdType": {
+ "enum": [
+ "exists",
+ "doesNotExist",
+ "atLeast",
+ "atMost",
+ "equal",
+ "between",
+ "isOneOf",
+ "contains",
+ "isNot",
+ "isAllOf",
+ "none"
+ ],
+ "type": "string"
+ },
+ "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\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"
+ ],
+ "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"
+ },
+ "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\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\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"
+ },
+ "GsaAttributesInfo": {
+ "required": [
+ "attributes"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ }
+ }
+ },
+ "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\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
+ },
+ "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"
+ },
+ "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
+ },
+ "GsaConfigurationsInfo": {
+ "required": [
+ "configurations"
+ ],
+ "type": "object",
+ "properties": {
+ "configurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimConfiguration"
+ }
+ }
+ },
+ "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"
+ },
+ "GsaConstantDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaConstantsInfo": {
+ "type": "object",
+ "properties": {
+ "constants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimConstant"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "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
+ },
+ "GsaCreateAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "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 * 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": {
+ "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
+ },
+ "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
+ },
+ "GsaCreateContinuousRange": {
+ "required": [
+ "highValue",
+ "lowValue"
+ ],
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaCreateCrossDatabaseRecordLinkGroup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaCreateDataRule": {
+ "required": [
+ "description",
+ "name",
+ "regularExpression"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaCreateDateTimeAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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\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\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\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"
+ },
+ "GsaCreateDiscreteFunctionalAttributeNumericParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateDiscreteFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "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"
+ },
+ "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\r\n * 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\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\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\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"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaCreateDynamicRecordLinkGroup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup"
+ },
+ {
+ "required": [
+ "attributePairs"
+ ],
+ "type": "object",
+ "properties": {
+ "forbidOrphans": {
+ "type": "boolean"
+ },
+ "referentialIntegrityModel": {
+ "$ref": "#/components/schemas/GsaReferentialIntegrityModel"
+ },
+ "attributePairs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaCreateAttributeLinkPair"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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\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": {
+ "type": "string",
+ "nullable": true
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaCreateFloatFunctionalAttributeDiscreteParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaCreateFloatFunctionalAttributeNumericParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateFloatFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GsaAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GsaAttributeScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "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\r\n * 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\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": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Layouts"
+ },
+ "GsaCreateLayoutSection": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Layout Sections\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "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\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\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\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",
+ "format": "int32",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "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\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\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\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\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\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\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\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\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\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\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\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\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\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
+ },
+ "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": {
+ "type": "string",
+ "nullable": true
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "defaultContent": {
+ "$ref": "#/components/schemas/GsaCreateMathsContent"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GsaParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GsaParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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\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\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"
+ },
+ "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/GsaCreateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaCreatePointAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ },
+ "GsaCreateRangeAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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": [
+ "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 * GsaCreateStaticRecordLinkGroup\r\n * GsaCreateDynamicRecordLinkGroup\r\n * GsaCreateCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GsaCreateStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GsaCreateDynamicRecordLinkGroup",
+ "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
+ },
+ "GsaCreateSearchRequest": {
+ "type": "object",
+ "properties": {
+ "searchConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "detail": {
+ "$ref": "#/components/schemas/GsaSearchDetail"
+ }
+ },
+ "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\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": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$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
+ },
+ "GsaCreateStaticRecordLinkGroup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "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"
+ },
+ "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\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": "\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"
+ }
+ }
+ },
+ "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
+ },
+ "GsaCreateUnitSystem": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Create dto for Unit Systems\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types"
+ },
+ "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\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"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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\r\n * GsaFreeTextCriterion\r\n * GsaFreeTextPrefixCriterion\r\n * GsaRecordListMemberCriterion\r\n * GsaRecordPropertyCriterion\r\n * GsaRecordReferenceCriterion\r\n * GsaRecordAncestorCriterion\r\n * GsaRecordAncestorHistoryIdentitiesCriterion\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",
+ "recordAncestorIdentities": "#/components/schemas/GsaRecordAncestorHistoryIdentitiesCriterion",
+ "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",
+ "recordAncestorIdentities",
+ "subset",
+ "tabularLinkingValue",
+ "attribute",
+ "localColumn",
+ "namedCriterion"
+ ],
+ "type": "string"
+ },
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'",
+ "x-discriminator-value": "crossDatabase",
+ "x-discriminator-name": "type"
+ },
+ "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\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"
+ },
+ "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\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\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\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'",
+ "x-discriminator-value": "dateTime",
+ "x-discriminator-name": "datumType"
+ },
+ "GsaDataExportDatum": {
+ "required": [
+ "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",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "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"
+ }
+ }
+ },
+ "GsaDataExportDiscreteDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteValue"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportDiscreteFunctionalDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "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
+ }
+ },
+ "discriminator": {
+ "propertyName": "graphType",
+ "mapping": {
+ "grid": "#/components/schemas/GsaDataExportDiscreteFunctionalGridDatum",
+ "series": "#/components/schemas/GsaDataExportDiscreteFunctionalSeriesDatum"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportDiscreteFunctionalGridDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportDiscreteGridPoint"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportDiscreteFunctionalSeriesDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportDiscreteFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportDiscreteSeries"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportDiscreteGridPoint": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportParameterValue"
+ },
+ "nullable": true
+ },
+ "value": {
+ "$ref": "#/components/schemas/GsaDiscreteValue"
+ }
+ },
+ "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"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataExportFileDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "$ref": "#/components/schemas/GsaDataExportBinaryData"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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"
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "isLogarithmic": {
+ "type": "boolean"
+ }
+ },
+ "discriminator": {
+ "propertyName": "graphType",
+ "mapping": {
+ "grid": "#/components/schemas/GsaDataExportFunctionalGridDatum",
+ "series": "#/components/schemas/GsaDataExportFunctionalSeriesDatum"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportFunctionalGridDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportFloatFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportGridPoint"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportFunctionalSeriesDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportFloatFunctionalDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportSeries"
+ },
+ "nullable": true
+ },
+ "showAsTable": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportGraphDecoration": {
+ "enum": [
+ "Lines",
+ "Markers",
+ "LinesAndMarkers"
+ ],
+ "type": "string",
+ "description": "Indicates how a graphical representation of a graph should be renderedPossible values:
\r\n\r\n- Lines: Lines
\r\n- Markers: Markers
\r\n- LinesAndMarkers: Lines and Markers
\r\n
\r\n"
+ },
+ "GsaDataExportGridPoint": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportParameterValue"
+ },
+ "nullable": true
+ },
+ "lowValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataExportHyperlink": {
+ "type": "object",
+ "properties": {
+ "address": {
+ "type": "string",
+ "nullable": true
+ },
+ "formattedAddress": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataExportHyperlinkDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "$ref": "#/components/schemas/GsaDataExportHyperlink"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportLinkDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "required": [
+ "linkDatumType"
+ ],
+ "type": "object",
+ "properties": {
+ "linkDatumType": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "discriminator": {
+ "propertyName": "linkDatumType",
+ "mapping": {
+ "linkGroup": "#/components/schemas/GsaDataExportLinkedRecordsDatum",
+ "tabular": "#/components/schemas/GsaDataExportTabularDatum"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ },
+ "linkGroupIdentitiesByDatabaseKey": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "rolledUpData": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportRollupDatum"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportLongTextDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportNotApplicableDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumType": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportNumericDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportNumericRollupDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportRollupDatum"
+ },
+ {
+ "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\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"
+ },
+ "valueName": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataExportPictureDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "$ref": "#/components/schemas/GsaDataExportBinaryData"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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/GsaDataExportApplicableDatum"
+ },
+ {
+ "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\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": {
+ "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/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "$ref": "#/components/schemas/GsaDataExportRange"
+ },
+ "isEstimated": {
+ "type": "boolean"
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportRequest": {
+ "required": [
+ "attributes",
+ "recordProperties"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaAttributeToExport"
+ }
+ },
+ "recordProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaRecordProperty"
+ }
+ },
+ "recordHistoryIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "recordHistoryGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "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"
+ },
+ "GsaDataExportResponse": {
+ "required": [
+ "failures",
+ "results"
+ ],
+ "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
+ },
+ "GsaDataExportRollupDatum": {
+ "required": [
+ "type"
+ ],
+ "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"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "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"
+ }
+ }
+ },
+ "GsaDataExportSeries": {
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportParameterValue"
+ },
+ "nullable": true
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportSeriesPoint"
+ },
+ "nullable": true
+ },
+ "graphDecoration": {
+ "$ref": "#/components/schemas/GsaDataExportGraphDecoration"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataExportSeriesPoint": {
+ "type": "object",
+ "properties": {
+ "xValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "xName": {
+ "type": "string",
+ "nullable": true
+ },
+ "yLowValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "yHighValue": {
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataExportShortTextDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportApplicableDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "datumValue": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportTabularRow": {
+ "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/GsaRecordReference"
+ },
+ "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
+ },
+ "GsaDataExportUnknownDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportDatum"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportValueRollupDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataExportValuesRollupDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataExportRollupDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "nullable": true
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDataModificationErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaUsageDataModificationErrorDetail",
+ "discriminator": {
+ "propertyName": "reason",
+ "mapping": {
+ "usage": "#/components/schemas/GsaUsageDataModificationErrorDetail"
+ }
+ }
+ },
+ "GsaDataRule": {
+ "required": [
+ "description",
+ "guid",
+ "name",
+ "regularExpression",
+ "usedByAttributes"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "usedByAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataRulesInfo": {
+ "type": "object",
+ "properties": {
+ "dataRules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataRule"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDataUsageDataModificationErrorDetail": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDatabase": {
+ "required": [
+ "isLocked",
+ "isReadOnly",
+ "key",
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "string",
+ "nullable": true
+ },
+ "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
+ },
+ "GsaDatabaseKeyProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDatabaseStatus": {
+ "enum": [
+ "Unknown",
+ "Ok",
+ "Unloaded",
+ "Loading",
+ "Unloading",
+ "FailedToLoad",
+ "FailedToUnload",
+ "Disabled",
+ "SchemaUpgradeRequired",
+ "SchemaDowngradeRequired"
+ ],
+ "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"
+ },
+ "GsaDatabaseStatusInformation": {
+ "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."
+ },
+ "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
+ },
+ "GsaDatabasesInfo": {
+ "type": "object",
+ "properties": {
+ "databases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimDatabase"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDateTimeAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDateTimeAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDateTimeDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "dateTime"
+ ],
+ "type": "object",
+ "properties": {
+ "dateTime": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDateTimeDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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": "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"
+ },
+ "GsaDateTimeDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'",
+ "x-discriminator-value": "dateTime",
+ "x-discriminator-name": "type"
+ },
+ "GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "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,
+ "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\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"
+ },
+ "GsaDateTimeFixedWidthHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "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
+ }
+ }
+ }
+ ],
+ "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\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
+ },
+ "GsaDateTimeHistogramAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GsaDateTimeHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDateTimeHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "description": "The maximum number of buckets to return.",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeHistogram'",
+ "x-discriminator-value": "dateTimeHistogram",
+ "x-discriminator-name": "type"
+ },
+ "GsaDateTimeHistogramBucket": {
+ "type": "object",
+ "properties": {
+ "lower": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDatum": {
+ "required": [
+ "notApplicable"
+ ],
+ "type": "object",
+ "properties": {
+ "notApplicable": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "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"
+ }
+ }
+ },
+ "GsaDatumCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaDatumCriterionType"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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/GsaDatumRollup"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteRollup'",
+ "x-discriminator-value": "discreteRollup",
+ "x-discriminator-name": "type"
+ },
+ "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/GsaExportFailure"
+ },
+ {
+ "required": [
+ "failedDatum"
+ ],
+ "type": "object",
+ "properties": {
+ "failedDatum": {
+ "$ref": "#/components/schemas/GsaDatumReference"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDatumIntegerRollup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumRollup"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerRollup'",
+ "x-discriminator-value": "integerRollup",
+ "x-discriminator-name": "type"
+ },
+ "GsaDatumListRollup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumRollup"
+ },
+ {
+ "required": [
+ "datums"
+ ],
+ "type": "object",
+ "properties": {
+ "datums": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDatum"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'listRollup'",
+ "x-discriminator-value": "listRollup",
+ "x-discriminator-name": "type"
+ },
+ "GsaDatumNumericalRollup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumRollup"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'numericalRollup'",
+ "x-discriminator-value": "numericalRollup",
+ "x-discriminator-name": "type"
+ },
+ "GsaDatumReference": {
+ "required": [
+ "attributeIdentity",
+ "databaseKey",
+ "recordHistoryIdentity"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDatumRollup": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaDatumRollupType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaDatumListRollup\r\n * GsaDatumIntegerRollup\r\n * GsaDatumNumericalRollup\r\n * GsaDatumDiscreteRollup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "listRollup": "#/components/schemas/GsaDatumListRollup",
+ "integerRollup": "#/components/schemas/GsaDatumIntegerRollup",
+ "numericalRollup": "#/components/schemas/GsaDatumNumericalRollup",
+ "discreteRollup": "#/components/schemas/GsaDatumDiscreteRollup"
+ }
+ }
+ },
+ "GsaDatumRollupType": {
+ "enum": [
+ "listRollup",
+ "integerRollup",
+ "numericalRollup",
+ "discreteRollup"
+ ],
+ "type": "string",
+ "description": "The datum rollup types that are supported by the API.Possible values:
\r\n\r\n- ListRollup: List rollup
\r\n- IntegerRollup: Integer rollup
\r\n- NumericalRollup: Numerical rollup
\r\n- DiscreteRollup: Discrete 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"
+ },
+ "GsaDefaultParameterValueUsageDataModificationErrorDetail": {
+ "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\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'defaultParameterValue'",
+ "x-discriminator-value": "defaultParameterValue",
+ "x-discriminator-name": "referencedByType"
+ },
+ "GsaDeleteRecordListItem": {
+ "required": [
+ "databaseGuid",
+ "recordHistoryGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordVersion": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDeleteRecordListItems": {
+ "required": [
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDeleteRecordListItem"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "required": [
+ "discreteType",
+ "isMultiValued"
+ ],
+ "type": "object",
+ "properties": {
+ "discreteType": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDiscreteDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "discreteValues"
+ ],
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue"
+ }
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'",
+ "x-discriminator-value": "discrete",
+ "x-discriminator-name": "type"
+ },
+ "GsaDiscreteFunctionalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "required": [
+ "attributeParameters",
+ "discreteType"
+ ],
+ "type": "object",
+ "properties": {
+ "discreteType": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteFunctionalAttributeDiscreteParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaDiscreteFunctionalAttributeNumericParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDiscreteFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDiscreteFunctionalAttributeParameter": {
+ "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 * GsaDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaDiscreteFunctionalAttributeNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaDiscreteFunctionalAttributeDiscreteParameter",
+ "numeric": "#/components/schemas/GsaDiscreteFunctionalAttributeNumericParameter"
+ }
+ }
+ },
+ "GsaDiscreteFunctionalDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "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"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDiscreteFunctionalDatumExistsCriterion": {
+ "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\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",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDiscreteFunctionalDatum"
+ },
+ {
+ "required": [
+ "graph"
+ ],
+ "type": "object",
+ "properties": {
+ "graph": {
+ "$ref": "#/components/schemas/GsaDiscreteGridGraph"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteFunctionalRangeDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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,
+ "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"
+ },
+ "GsaDiscreteFunctionalSeriesDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDiscreteFunctionalDatum"
+ },
+ {
+ "required": [
+ "graph"
+ ],
+ "type": "object",
+ "properties": {
+ "graph": {
+ "$ref": "#/components/schemas/GsaDiscreteSeriesGraph"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteFunctionalValuesDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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,
+ "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"
+ },
+ "GsaDiscreteGridGraph": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaGridGraph"
+ },
+ {
+ "required": [
+ "points"
+ ],
+ "type": "object",
+ "properties": {
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteGridPoint"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDiscreteGridPoint": {
+ "required": [
+ "constraints",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "constraints": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaParameterWithDataValue"
+ }
+ },
+ "value": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteGuidDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuid'",
+ "x-discriminator-value": "discreteGuid",
+ "x-discriminator-name": "type"
+ },
+ "GsaDiscreteGuidValuesDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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
+ }
+ }
+ }
+ ],
+ "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\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"
+ },
+ "GsaDiscreteIdentityValuesDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentityValues'",
+ "x-discriminator-value": "discreteIdentityValues",
+ "x-discriminator-name": "type"
+ },
+ "GsaDiscreteParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameter"
+ },
+ {
+ "required": [
+ "values"
+ ],
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteParameterValue"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDiscreteParameterContent": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "parameterValue": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GsaDiscreteRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDiscreteParameterDataValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterDataValue"
+ },
+ {
+ "required": [
+ "parameterValue"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValue": {
+ "$ref": "#/components/schemas/GsaDiscreteParameterValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaDiscreteParameterNameConstraint": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterConstraint"
+ },
+ {
+ "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: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteName'",
+ "x-discriminator-value": "discreteName",
+ "x-discriminator-name": "type"
+ },
+ "GsaDiscreteParameterValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterValue"
+ },
+ {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteParameterValueConstraint": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterConstraint"
+ },
+ {
+ "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: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteValue'",
+ "x-discriminator-value": "discreteValue",
+ "x-discriminator-name": "type"
+ },
+ "GsaDiscreteRange": {
+ "required": [
+ "parameterValues"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteRangeDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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": "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"
+ },
+ "GsaDiscreteSeries": {
+ "required": [
+ "constraints",
+ "points"
+ ],
+ "type": "object",
+ "properties": {
+ "constraints": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaParameterWithDataValue"
+ }
+ },
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteSeriesPoint"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteSeriesGraph": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSeriesGraph"
+ },
+ {
+ "required": [
+ "series"
+ ],
+ "type": "object",
+ "properties": {
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteSeries"
+ }
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteSeriesPoint": {
+ "required": [
+ "value",
+ "xValue"
+ ],
+ "type": "object",
+ "properties": {
+ "xValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "value": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteTextAggregation": {
+ "type": "object",
+ "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 extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteText'",
+ "x-discriminator-value": "discreteText",
+ "x-discriminator-name": "datumType"
+ },
+ "GsaDiscreteTextAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "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
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteTextDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "textMatchBehavior": {
+ "$ref": "#/components/schemas/GsaTextMatchBehavior"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteTextPrefixDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "prefix"
+ ],
+ "type": "object",
+ "properties": {
+ "prefix": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaDiscreteTextValuesDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "any": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "none": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextValues'",
+ "x-discriminator-value": "discreteTextValues",
+ "x-discriminator-name": "type"
+ },
+ "GsaDiscreteType": {
+ "required": [
+ "guid",
+ "isOrdered",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteTypeDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteTypeUsage": {
+ "required": [
+ "attributes",
+ "tabularColumns"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ }
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaTabularAttributeWithColumns"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteTypesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteType"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteValue": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ },
+ "order": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteValueDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "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"
+ },
+ "GsaDiscreteValuesDiscreteValue": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteValuesDiscreteValuesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteValuesReplaceDiscreteValuesInfo": {
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaDiscreteValuesUpdateDiscreteValue": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "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"
+ },
+ {
+ "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"
+ },
+ "GsaDynamicLinkGroupUsageDataModificationErrorDetail": {
+ "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\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'dynamicLinkGroup'",
+ "x-discriminator-value": "dynamicLinkGroup",
+ "x-discriminator-name": "referencedByType"
+ },
+ "GsaDynamicRecordLinkGroup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaRecordLinkGroup"
+ },
+ {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamic'",
+ "x-discriminator-value": "dynamic",
+ "x-discriminator-name": "type"
+ },
+ "GsaEnabledLicensesInfo": {
+ "required": [
+ "isFlexLicensingEnabled",
+ "miServerEnabled",
+ "MLEnabled",
+ "PLMSyncEnabled",
+ "restrictedSubstancesBAEnabled",
+ "sustainabilityEnabledEnabled",
+ "workflowAdvancedEnabled"
+ ],
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "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."
+ },
+ "workflowAdvancedEnabled": {
+ "type": "boolean",
+ "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."
+ },
+ "restrictedSubstancesBAEnabled": {
+ "type": "boolean",
+ "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."
+ },
+ "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."
+ },
+ "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": "Gets expiry date of Server license.",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "Stores information about the state of the MI Server license."
+ },
+ "GsaErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaExcludeValuesSpecifier": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "excludedIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "excludedGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "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\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'exclude'",
+ "x-discriminator-value": "exclude",
+ "x-discriminator-name": "filterOn"
+ },
+ "GsaExportFailure": {
+ "required": [
+ "failureDetails",
+ "failureReason",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaExportFailureType"
+ },
+ "failureDetails": {
+ "type": "string"
+ },
+ "failureReason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "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
+ },
+ "GsaExpressionUsageDataModificationErrorDetail": {
+ "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\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'expression'",
+ "x-discriminator-value": "expression",
+ "x-discriminator-name": "referencedByType"
+ },
+ "GsaExpressionsInfo": {
+ "type": "object",
+ "properties": {
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimExpression"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaFileAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFileDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "contentIsInSearchIndex",
+ "contentType",
+ "description",
+ "fileName",
+ "target"
+ ],
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "contentType": {
+ "type": "string"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GsaHyperlinkTarget"
+ },
+ "contentIsInSearchIndex": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFileDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFileDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'",
+ "x-discriminator-value": "file",
+ "x-discriminator-name": "type"
+ },
+ "GsaFileHeader": {
+ "required": [
+ "dataLength",
+ "description",
+ "extension",
+ "folderGuid",
+ "guid",
+ "name",
+ "path"
+ ],
+ "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"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "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": {
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimFile"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaFindSearchRequest": {
+ "type": "object",
+ "properties": {
+ "nameContains": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaFindStandardNames": {
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaFloatFunctionalAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "seriesGraphs": {
+ "$ref": "#/components/schemas/GsaFloatFunctionalSeriesGraphAggregation"
+ },
+ "gridGraphs": {
+ "$ref": "#/components/schemas/GsaFloatFunctionalGridGraphAggregation"
+ }
+ }
+ }
+ ],
+ "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",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "numberOfParameterValues": {
+ "type": "integer",
+ "description": "The maximum number of values to return in this aggregation.",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaFloatFunctionalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "required": [
+ "attributeParameters",
+ "isRange"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFloatFunctionalAttributeDiscreteParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaFloatFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GsaAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GsaAttributeScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "parameter": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "GsaFloatFunctionalDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "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"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFloatFunctionalDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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": "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"
+ },
+ "GsaFloatFunctionalDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'",
+ "x-discriminator-value": "floatFunctional",
+ "x-discriminator-name": "type"
+ },
+ "GsaFloatFunctionalGraphDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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": "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"
+ },
+ "GsaFloatFunctionalGridDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaFloatFunctionalDatum"
+ },
+ {
+ "required": [
+ "graph"
+ ],
+ "type": "object",
+ "properties": {
+ "graph": {
+ "$ref": "#/components/schemas/GsaFloatGridGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ },
+ "GsaFloatFunctionalSeriesDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaFloatFunctionalDatum"
+ },
+ {
+ "required": [
+ "graph"
+ ],
+ "type": "object",
+ "properties": {
+ "graph": {
+ "$ref": "#/components/schemas/GsaFloatSeriesGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ },
+ "GsaFloatGridGraph": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaGridGraph"
+ },
+ {
+ "required": [
+ "points"
+ ],
+ "type": "object",
+ "properties": {
+ "points": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaFloatGridPoint"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ },
+ "GsaFloatSeries": {
+ "required": [
+ "constraints",
+ "graphDecoration",
+ "points"
+ ],
+ "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
+ },
+ "GsaFloatSeriesGraph": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSeriesGraph"
+ },
+ {
+ "required": [
+ "series"
+ ],
+ "type": "object",
+ "properties": {
+ "series": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaFloatSeries"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFloatSeriesPoint": {
+ "required": [
+ "estimated",
+ "xValue",
+ "yHighValue",
+ "yLowValue"
+ ],
+ "type": "object",
+ "properties": {
+ "xValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "yLowValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "yHighValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "estimated": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaFolder": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "parentGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaFoldersInfo": {
+ "type": "object",
+ "properties": {
+ "folders": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaFolder"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaFreeTextAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "description": "The GUID of the input aggregation criterion.",
+ "format": "uuid"
+ },
+ "terms": {
+ "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
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFreeTextAggregationCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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": "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"
+ },
+ "GsaFreeTextCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaBoostByGuid"
+ },
+ "nullable": true
+ },
+ "columnIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "columnGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaBoostByGuid"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFreeTextPrefixCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaBoostByGuid"
+ },
+ "nullable": true
+ },
+ "columnIdentitiesToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaBoostByIdentity"
+ },
+ "nullable": true
+ },
+ "columnGuidsToBoost": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaBoostByGuid"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFullLayoutSection": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLayoutSection"
+ },
+ {
+ "required": [
+ "sectionItems"
+ ],
+ "type": "object",
+ "properties": {
+ "sectionItems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaLayoutItem"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaFullNameProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "fullName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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
+ },
+ "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
+ },
+ "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"
+ },
+ "GsaGeneratedIntegrationSchemaOfObjectIdentifier": {
+ "required": [
+ "schema"
+ ],
+ "type": "object",
+ "properties": {
+ "warnings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaIntegrationSchemaGenerationErrorDetail"
+ },
+ "nullable": true
+ },
+ "schema": {
+ "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier"
+ }
+ },
+ "additionalProperties": false
+ },
+ "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/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaGraph": {
+ "required": [
+ "graphType"
+ ],
+ "type": "object",
+ "properties": {
+ "graphType": {
+ "$ref": "#/components/schemas/GsaGraphType"
+ }
+ },
+ "additionalProperties": false,
+ "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"
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "GsaGridGraph": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaGraph"
+ },
+ {
+ "required": [
+ "allParameters",
+ "defaultXAxisParameter",
+ "functionalType"
+ ],
+ "type": "object",
+ "properties": {
+ "functionalType": {
+ "$ref": "#/components/schemas/GsaFunctionalType"
+ },
+ "defaultXAxisParameter": {
+ "$ref": "#/components/schemas/GsaSlimParameter"
+ },
+ "allParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimParameter"
+ }
+ }
+ },
+ "discriminator": {
+ "propertyName": "functionalType",
+ "mapping": {
+ "float": "#/components/schemas/GsaFloatGridGraph",
+ "discrete": "#/components/schemas/GsaDiscreteGridGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaGuidOnlyAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "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
+ },
+ "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
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaGuidOnlyIntegrationParameterInfo"
+ },
+ "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."
+ },
+ "GsaGuidOnlyDiscreteType": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "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."
+ },
+ "GsaGuidOnlyIntegrationParameterInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "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
+ },
+ "GsaGuidOnlyIntegrationSchemaOfObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "nullable": true
+ },
+ "version": {
+ "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"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Similar to IntegrationSchema, but without identities.\r\nUsed when we don't want consumers to specify/know about identities."
+ },
+ "GsaGuidOnlyLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "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."
+ },
+ "GsaGuidOnlyMappingOfObjectIdentifier": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/components/schemas/GsaObjectIdentifier"
+ },
+ "targetGuid": {
+ "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."
+ },
+ "GsaGuidOnlySourceOfObjectIdentifier": {
+ "required": [
+ "mappings",
+ "table"
+ ],
+ "type": "object",
+ "properties": {
+ "database": {
+ "$ref": "#/components/schemas/GsaObjectIdentifier"
+ },
+ "databaseKey": {
+ "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."
+ }
+ },
+ "additionalProperties": false,
+ "description": "A source table from which integrated data will be taken."
+ },
+ "GsaHistogram": {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaHistogramBucket"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaHistogramBucket": {
+ "type": "object",
+ "properties": {
+ "lower": {
+ "type": "number",
+ "format": "double"
+ },
+ "upper": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaHyperlinkAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaHyperlinkDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "address",
+ "description",
+ "target"
+ ],
+ "type": "object",
+ "properties": {
+ "address": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GsaHyperlinkTarget"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaHyperlinkDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaHyperlinkDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'",
+ "x-discriminator-value": "hyperlink",
+ "x-discriminator-name": "type"
+ },
+ "GsaHyperlinkPrefixDatumCriterion": {
+ "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 '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"
+ },
+ "GsaIndexRecordFailure": {
+ "type": "object",
+ "properties": {
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "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": "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"
+ },
+ "GsaIntegerAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaIntegerAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'",
+ "x-discriminator-value": "integer",
+ "x-discriminator-name": "type"
+ },
+ "GsaIntegerAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "required": [
+ "isUnique"
+ ],
+ "type": "object",
+ "properties": {
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaIntegerDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaIntegerDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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": "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"
+ },
+ "GsaIntegerDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'",
+ "x-discriminator-value": "integer",
+ "x-discriminator-name": "type"
+ },
+ "GsaIntegerFixedWidthHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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": "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"
+ },
+ "GsaIntegerHistogramAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GsaHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaIntegerHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerHistogram'",
+ "x-discriminator-value": "integerHistogram",
+ "x-discriminator-name": "type"
+ },
+ "GsaIntegrationAttribute": {
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "identity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
+ "type": "string",
+ "description": "Set as nullable for older schema compatibility,\r\nbut we expect it to be set almost everywhere,\r\nexcept during loading from disk.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ },
+ "unitSymbol": {
+ "type": "string",
+ "description": "If isUnitted is true, then this must have a non empty value",
+ "nullable": true
+ },
+ "isUnitted": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "discreteTypeIdentity": {
+ "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"
+ },
+ "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."
+ },
+ "GsaIntegrationDataExportRequest": {
+ "required": [
+ "attributeIdentities",
+ "recordReferences"
+ ],
+ "type": "object",
+ "properties": {
+ "recordReferences": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaRecordReference"
+ },
+ "description": "A list of records to export. These are references to the underlying records in the source database"
+ },
+ "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",
+ "nullable": true
+ },
+ "name": {
+ "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."
+ },
+ "GsaIntegrationLayout": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "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",
+ "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
+ },
+ "GsaIntegrationSchemaGenerationErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaIntegrationSchemaOfObjectIdentifier": {
+ "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
+ },
+ "accessControlCategoryValues": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "nullable": true
+ },
+ "securityGroups": {
+ "$ref": "#/components/schemas/GsaSecurityGroups"
+ }
+ },
+ "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."
+ },
+ "GsaIntegrationSchemaStatus": {
+ "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
+ },
+ "erroredDatabases": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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
+ },
+ "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
+ },
+ "recordsThatFailedToIndex": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaIndexRecordFailure"
+ },
+ "description": "Details of any records that failed to index.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaInvalidParentStateErrorDetail": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaInvalidVersionStateErrorDetail": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "versionState": {
+ "$ref": "#/components/schemas/GsaVersionState"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaJob": {
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "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",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "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\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedByUser'",
+ "x-discriminator-value": "lastModifiedByUser",
+ "x-discriminator-name": "propertyName"
+ },
+ "GsaLastModifiedDateProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "lastModifiedDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLayout": {
+ "required": [
+ "applicableApplications",
+ "displayNames",
+ "guid",
+ "name",
+ "sections"
+ ],
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaLayoutAttributeItem": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLayoutItem"
+ },
+ {
+ "required": [
+ "attributeType",
+ "readOnly",
+ "required"
+ ],
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaLayoutTabularColumn"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLayoutItem": {
+ "required": [
+ "guid",
+ "itemType",
+ "name",
+ "underlyingEntityGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "itemType": {
+ "$ref": "#/components/schemas/GsaLayoutItemType"
+ },
+ "underlyingEntityGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "GsaLayoutItemLinkType": {
+ "enum": [
+ "recordLink",
+ "smartLink",
+ "crossDatabaseLink",
+ "associationChain"
+ ],
+ "type": "string",
+ "description": "The types of layout items that represent links to another table."
+ },
+ "GsaLayoutItemType": {
+ "enum": [
+ "attribute",
+ "link"
+ ],
+ "type": "string",
+ "description": "The types of layout item that are supported by the API."
+ },
+ "GsaLayoutLinkItem": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLayoutItem"
+ },
+ {
+ "required": [
+ "forwards",
+ "linkType",
+ "targetTable"
+ ],
+ "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"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLayoutSection": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "sectionDetailType"
+ ],
+ "type": "object",
+ "properties": {
+ "sectionDetailType": {
+ "$ref": "#/components/schemas/GsaLayoutSectionDetailType"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "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"
+ }
+ }
+ },
+ "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
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaLayoutTabularColumn": {
+ "required": [
+ "columnType",
+ "guid",
+ "name",
+ "tabularColumnGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "$ref": "#/components/schemas/GsaTabularColumnDtoType"
+ },
+ "tabularColumnGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaLayoutsInfo": {
+ "type": "object",
+ "properties": {
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimLayout"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaLinkAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localAggregations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaLocalColumnAggregation"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLinkAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "localAggregationCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'",
+ "x-discriminator-value": "link",
+ "x-discriminator-name": "type"
+ },
+ "GsaLinkAttributeToExport": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttributeToExport"
+ },
+ {
+ "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": {
+ "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": "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"
+ },
+ "GsaLinkAttributeType": {
+ "enum": [
+ "recordLink",
+ "crossDatabaseLink",
+ "dynamicLink",
+ "tabularAttribute"
+ ],
+ "type": "string"
+ },
+ "GsaLinkDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "linkDatumType"
+ ],
+ "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"
+ },
+ "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": "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\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"
+ },
+ "GsaLinkExistsDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumExistsCriterion"
+ },
+ {
+ "required": [
+ "targetDatabaseKey"
+ ],
+ "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
+ }
+ }
+ }
+ ],
+ "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\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"
+ },
+ "GsaLinkExportFailure": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaExportFailure"
+ },
+ {
+ "required": [
+ "failedLink"
+ ],
+ "type": "object",
+ "properties": {
+ "failedLink": {
+ "$ref": "#/components/schemas/GsaLinkReference"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLinkInfo": {
+ "required": [
+ "linkSource",
+ "linkTarget"
+ ],
+ "type": "object",
+ "properties": {
+ "linkSource": {
+ "$ref": "#/components/schemas/GsaLinkTarget"
+ },
+ "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"
+ ],
+ "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"
+ },
+ "GsaLinkTarget": {
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "databaseVersionGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaLinkedAttributeTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "linkedAttribute"
+ ],
+ "type": "object",
+ "properties": {
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLinkedColumnTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "linkedAttribute",
+ "linkedColumn"
+ ],
+ "type": "object",
+ "properties": {
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ },
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaLinkedRecordExportBehavior": {
+ "type": "object",
+ "properties": {
+ "tabularRowBehavior": {
+ "$ref": "#/components/schemas/GsaTabularRowExportBehavior"
+ },
+ "summaryRollUpType": {
+ "$ref": "#/components/schemas/GsaTabularColumnRollUpType"
+ },
+ "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."
+ },
+ "GsaLinkedRecordTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLinkingValueExistsDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeType": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ },
+ "innerHitsIdentifier": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLinkingValueMatchBehavior": {
+ "enum": [
+ "AllRows",
+ "VisibleRows",
+ "ExactMatchMatchingRows",
+ "FreeTextMatchingRows"
+ ],
+ "type": "string",
+ "description": "Enum for use in the Granta.Server.Api.Search.TabularLinkingValueCriterion to control which tabular rows are returnedPossible 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"
+ },
+ "GsaLinksInfo": {
+ "required": [
+ "links"
+ ],
+ "type": "object",
+ "properties": {
+ "links": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaResolvedLink"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaListBooleanCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaListCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "matchAny": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaListCriterion"
+ },
+ "nullable": true
+ },
+ "matchAll": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaListCriterion"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'listBoolean'",
+ "x-discriminator-value": "listBoolean",
+ "x-discriminator-name": "type"
+ },
+ "GsaListCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "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\r\n * 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": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordVersion": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaListsPagingOptions": {
+ "type": "object",
+ "properties": {
+ "startIndex": {
+ "type": "integer",
+ "description": "The index of the first list in the collection to be returned. If not provided it will start at index 0.",
+ "format": "int32",
+ "nullable": true
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The number of lists to be returned per page. If not provided the number of returned lists will be unlimited.",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaListsUserOrGroup": {
+ "required": [
+ "displayName",
+ "identifier",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayName": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaLocalColumnAggregation": {
+ "required": [
+ "localColumnAggregationType"
+ ],
+ "type": "object",
+ "properties": {
+ "localColumnIdentity": {
+ "type": "integer",
+ "description": "The identity of the local column that was aggregated over.",
+ "format": "int32",
+ "nullable": true
+ },
+ "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": "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"
+ }
+ }
+ },
+ "GsaLocalColumnAggregationCriterion": {
+ "required": [
+ "localColumnAggregationCriterionType"
+ ],
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "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\r\n * GsaLocalColumnAggregationExistsCriterion",
+ "discriminator": {
+ "propertyName": "localColumnAggregationCriterionType",
+ "mapping": {
+ "value": "#/components/schemas/GsaLocalColumnAggregationValueCriterion",
+ "exists": "#/components/schemas/GsaLocalColumnAggregationExistsCriterion"
+ }
+ }
+ },
+ "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": [
+ "value",
+ "exists"
+ ],
+ "type": "string"
+ },
+ "GsaLocalColumnAggregationValueCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLocalColumnAggregationCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'value'",
+ "x-discriminator-value": "value",
+ "x-discriminator-name": "localColumnAggregationCriterionType"
+ },
+ "GsaLocalColumnCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "required": [
+ "localColumnCriterionType"
+ ],
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "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": "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"
+ },
+ "GsaLocalColumnExistsAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLocalColumnAggregation"
+ },
+ {
+ "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\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"
+ },
+ {
+ "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\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"
+ },
+ {
+ "required": [
+ "innerCriterion"
+ ],
+ "type": "object",
+ "properties": {
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'matches'",
+ "x-discriminator-value": "matches",
+ "x-discriminator-name": "localColumnCriterionType"
+ },
+ "GsaLocalColumnNotApplicableCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLocalColumnCriterion"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'notApplicable'",
+ "x-discriminator-value": "notApplicable",
+ "x-discriminator-name": "localColumnCriterionType"
+ },
+ "GsaLocalColumnValueAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLocalColumnAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "aggregationDatum": {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'value'",
+ "x-discriminator-value": "value",
+ "x-discriminator-name": "localColumnAggregationType"
+ },
+ "GsaLocalDateTimeTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalDiscreteTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType",
+ "discreteType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalFileTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalHyperlinkTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalIntegerTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalLogicalTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalLongTextTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalPictureTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalPointTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLocalRangeTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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/GsaTabularColumn"
+ },
+ {
+ "required": [
+ "defaultThresholdType"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLogicalAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaValueWithCountOfBoolean"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'",
+ "x-discriminator-value": "logical",
+ "x-discriminator-name": "type"
+ },
+ "GsaLogicalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLogicalDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLogicalDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean",
+ "description": "Logical search value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'",
+ "x-discriminator-value": "logical",
+ "x-discriminator-name": "type"
+ },
+ "GsaLongSortingValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLongTextAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLongTextDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "richTextValue"
+ ],
+ "type": "object",
+ "properties": {
+ "richTextValue": {
+ "$ref": "#/components/schemas/GsaRichTextValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLongTextDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Long text search value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaLongTextDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'",
+ "x-discriminator-value": "longText",
+ "x-discriminator-name": "type"
+ },
+ "GsaLongTextPrefixDatumCriterion": {
+ "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 '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
+ },
+ "GsaMathsFunctionalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "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"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaMathsFunctionalDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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": "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"
+ },
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'",
+ "x-discriminator-value": "mathsFunctional",
+ "x-discriminator-name": "type"
+ },
+ "GsaMiVersion": {
+ "type": "object",
+ "properties": {
+ "binaryCompatibilityVersion": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ },
+ "majorMinorVersion": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "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
+ },
+ "GsaNamedCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GsaCriterion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNewLayoutAssociationChainItem": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ {
+ "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: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'associationChain'",
+ "x-discriminator-value": "associationChain",
+ "x-discriminator-name": "itemType"
+ },
+ "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/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
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNewLayoutCrossDatabaseLinkItem": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ {
+ "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: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'crossDatabaseLink'",
+ "x-discriminator-value": "crossDatabaseLink",
+ "x-discriminator-name": "itemType"
+ },
+ "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/GsaNewLayoutItem"
+ },
+ {
+ "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"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNewLayoutSmartLinkItem": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaNewLayoutItem"
+ },
+ {
+ "required": [
+ "linkGroupGuid"
+ ],
+ "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)."
+ },
+ "linkGroupGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNoValuesSpecifier": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaValueSpecifier"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "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"
+ },
+ "GsaNotApplicableDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatum"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "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"
+ },
+ "GsaNotTheLatestVersionErrorDetail": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "newerVersion": {
+ "$ref": "#/components/schemas/GsaSlimRecordVersion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNotVersionedErrorDetail": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNumericParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameter"
+ },
+ {
+ "required": [
+ "interpolationType",
+ "isRestricted",
+ "scaleType",
+ "values"
+ ],
+ "type": "object",
+ "properties": {
+ "isRestricted": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaNumericParameterValue"
+ }
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GsaParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GsaParameterScaleType"
+ }
+ }
+ }
+ ],
+ "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"
+ },
+ "GsaNumericParameterConstraint": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterConstraint"
+ },
+ {
+ "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: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'",
+ "x-discriminator-value": "numeric",
+ "x-discriminator-name": "type"
+ },
+ "GsaNumericParameterContent": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GsaContinuousRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNumericParameterDataValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterDataValue"
+ },
+ {
+ "required": [
+ "parameterValue"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaNumericParameterValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaParameterValue"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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": {
+ "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."
+ },
+ "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"
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "defaultParameterValueGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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\r\n * GsaDiscreteParameterValueConstraint\r\n * 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\r\n * GsaNumericParameterContent",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaDiscreteParameterContent",
+ "numeric": "#/components/schemas/GsaNumericParameterContent"
+ }
+ }
+ },
+ "GsaParameterDataValue": {
+ "required": [
+ "parameterType"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterType": {
+ "$ref": "#/components/schemas/GsaParameterType"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "GsaParameterDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaParameterInfo": {
+ "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"
+ },
+ "defaultValue": {
+ "$ref": "#/components/schemas/GsaDataExportParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "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- ParameterLevel: Parameter Level
\r\n- AttributeLevel: Attribute Level
\r\n- DatumLevel: Datum Level
\r\n
\r\n"
+ },
+ "GsaParameterType": {
+ "enum": [
+ "discrete",
+ "numeric"
+ ],
+ "type": "string"
+ },
+ "GsaParameterValue": {
+ "required": [
+ "guid",
+ "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 * GsaDiscreteParameterValue\r\n * GsaNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaDiscreteParameterValue",
+ "numeric": "#/components/schemas/GsaNumericParameterValue"
+ }
+ }
+ },
+ "GsaParameterValueDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaParameterValueType": {
+ "enum": [
+ "discrete",
+ "numeric"
+ ],
+ "type": "string"
+ },
+ "GsaParameterWithDataValue": {
+ "required": [
+ "parameter",
+ "parameterDataValue"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ },
+ "parameterDataValue": {
+ "$ref": "#/components/schemas/GsaParameterDataValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaParametersInfo": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaParameter"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaPictureAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaPictureDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaPictureDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaPictureDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'",
+ "x-discriminator-value": "picture",
+ "x-discriminator-name": "type"
+ },
+ "GsaPointAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaPointAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'",
+ "x-discriminator-value": "point",
+ "x-discriminator-name": "type"
+ },
+ "GsaPointAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "required": [
+ "attributeParameters",
+ "isMultiValued"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaPointDataValue": {
+ "required": [
+ "parametersAndValues",
+ "pointValue"
+ ],
+ "type": "object",
+ "properties": {
+ "pointValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ },
+ "significantFiguresInfo": {
+ "$ref": "#/components/schemas/GsaSignificantFiguresInfo"
+ },
+ "parametersAndValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaParameterWithDataValue"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaPointDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "estimated",
+ "values"
+ ],
+ "type": "object",
+ "properties": {
+ "estimated": {
+ "type": "boolean"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaPointDataValue"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaPointDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "gte": {
+ "type": "number",
+ "description": "Greater than or equal",
+ "format": "double",
+ "nullable": true
+ },
+ "lte": {
+ "type": "number",
+ "description": "Less than or equal",
+ "format": "double",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'",
+ "x-discriminator-value": "point",
+ "x-discriminator-name": "type"
+ },
+ "GsaPointDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'",
+ "x-discriminator-value": "point",
+ "x-discriminator-name": "type"
+ },
+ "GsaPointFixedWidthHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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": "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"
+ },
+ "GsaPointHistogramAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GsaHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaPointHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointHistogram'",
+ "x-discriminator-value": "pointHistogram",
+ "x-discriminator-name": "type"
+ },
+ "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 * GsaCreatedByUserProperty\r\n * GsaCreatedDateProperty\r\n * GsaDatabaseKeyProperty\r\n * GsaFullNameProperty\r\n * GsaLastModifiedDateProperty\r\n * GsaLastModifiedByUserProperty\r\n * GsaRecordColorProperty\r\n * GsaRecordGuidProperty\r\n * GsaRecordIdentityProperty\r\n * GsaRecordHistoryGuidProperty\r\n * GsaRecordHistoryIdentityProperty\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": "propertyName",
+ "mapping": {
+ "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",
+ "recordIdentity": "#/components/schemas/GsaRecordIdentityProperty",
+ "recordHistoryGuid": "#/components/schemas/GsaRecordHistoryGuidProperty",
+ "recordHistoryIdentity": "#/components/schemas/GsaRecordHistoryIdentityProperty",
+ "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"
+ }
+ }
+ },
+ "GsaQueryAttribute": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "isHiddenFromSearchCriteria": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "info": {
+ "$ref": "#/components/schemas/GsaQueryAttributeInfo"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaQueryUnit"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GsaQueryDiscreteType"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GsaQueryDataRule"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GsaQueryTabularAttributeTarget"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntity"
+ },
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryAttributeFilter": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ },
+ "description": "Only include attributes of any of these types.\r\nNote that Tabular attributes have type: link.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "Optionally filter results"
+ },
+ "GsaQueryAttributeInfo": {
+ "type": "object",
+ "properties": {
+ "chartable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "orderedMetaAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntity"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryAttributeInfoProperties": {
+ "type": "object",
+ "properties": {
+ "chartable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "orderedMetaAttributes": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Set values to true to include those properties in the query response"
+ },
+ "GsaQueryAttributeProperties": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "defaultThresholdType": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isHiddenFromSearchCriteria": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "info": {
+ "$ref": "#/components/schemas/GsaQueryAttributeInfoProperties"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaQueryUnitProperties"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GsaQueryDiscreteTypeProperties"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GsaQueryDataRuleProperties"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GsaQueryTabularAttributeTargetProperties"
+ },
+ "tabularColumns": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties"
+ },
+ "attributeParameters": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties"
+ },
+ "expressions": {
+ "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties"
+ },
+ "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"
+ },
+ "GsaQueryAttributesInfo": {
+ "required": [
+ "attributes"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaQueryAttribute"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryAttributesRequest": {
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/components/schemas/GsaQueryAttributeProperties"
+ },
+ "filter": {
+ "$ref": "#/components/schemas/GsaQueryAttributeFilter"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryDataRule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "regularExpression": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryDataRuleProperties": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "regularExpression": {
+ "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"
+ },
+ "GsaQueryDiscreteType": {
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryDiscreteTypeProperties": {
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "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"
+ },
+ "GsaQuerySlimNamedEntity": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQuerySlimNamedEntityProperties": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "GsaQueryTabularAttributeTarget": {
+ "type": "object",
+ "properties": {
+ "targetDatabaseGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "targetDatabaseVersionGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "targetTableGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "targetAttributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryTabularAttributeTargetProperties": {
+ "type": "object",
+ "properties": {
+ "targetDatabaseGuid": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "targetDatabaseVersionGuid": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "targetTableGuid": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "targetAttributeGuid": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "Set values to true to include those properties in the query response"
+ },
+ "GsaQueryUnit": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "symbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaQueryUnitProperties": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "symbol": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "equation": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "guid": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "Set values to true to include those properties in the query response"
+ },
+ "GsaRangeAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "maximum": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRangeAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'",
+ "x-discriminator-value": "range",
+ "x-discriminator-name": "type"
+ },
+ "GsaRangeAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRangeDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "estimated",
+ "highValue",
+ "highValueIsInclusive",
+ "lowValue",
+ "lowValueIsInclusive"
+ ],
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "lowValueIsInclusive": {
+ "type": "boolean"
+ },
+ "highValueIsInclusive": {
+ "type": "boolean"
+ },
+ "lowValueSignificantFiguresInfo": {
+ "$ref": "#/components/schemas/GsaSignificantFiguresInfo"
+ },
+ "highValueSignificantFiguresInfo": {
+ "$ref": "#/components/schemas/GsaSignificantFiguresInfo"
+ },
+ "estimated": {
+ "type": "boolean"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRangeDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "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
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'",
+ "x-discriminator-value": "range",
+ "x-discriminator-name": "type"
+ },
+ "GsaRangeDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'",
+ "x-discriminator-value": "range",
+ "x-discriminator-name": "type"
+ },
+ "GsaRangeFixedWidthHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "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": "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"
+ },
+ "GsaRangeHistogramAggregation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatum"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "histogram": {
+ "$ref": "#/components/schemas/GsaHistogram"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRangeHistogramAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximumNumberOfBuckets": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeHistogram'",
+ "x-discriminator-value": "rangeHistogram",
+ "x-discriminator-name": "type"
+ },
+ "GsaRecordAncestorCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ancestorIdentity": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "directParentOnly": {
+ "type": "boolean",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor identity is provided, returns records that sit directly below the table\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"
+ },
+ "GsaRecordAncestorHistoryIdentitiesCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ancestorHistoryIdentities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records whose ancestors include one of the specified record history identities\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestorIdentities'",
+ "x-discriminator-value": "recordAncestorIdentities",
+ "x-discriminator-name": "type"
+ },
+ "GsaRecordColor": {
+ "enum": [
+ "red",
+ "lime",
+ "blue",
+ "yellow",
+ "fuchsia",
+ "aqua",
+ "maroon",
+ "green",
+ "navy",
+ "olive",
+ "purple",
+ "teal",
+ "gray",
+ "black",
+ "white",
+ "silver"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the supported record colors."
+ },
+ "GsaRecordColorProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordColor": {
+ "$ref": "#/components/schemas/GsaRecordColor"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRecordExportFailure": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaExportFailure"
+ },
+ {
+ "required": [
+ "failedRecords"
+ ],
+ "type": "object",
+ "properties": {
+ "failedRecords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaRecordReference"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRecordGuidProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRecordHistory": {
+ "required": [
+ "guid",
+ "isFolder",
+ "recordVersions",
+ "subsets",
+ "table"
+ ],
+ "type": "object",
+ "properties": {
+ "isFolder": {
+ "type": "boolean"
+ },
+ "table": {
+ "$ref": "#/components/schemas/GsaSlimTable"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/GsaSlimRecordHistory"
+ },
+ "recordVersions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimRecordVersion"
+ }
+ },
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimSubset"
+ }
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordHistoryCopyException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordHistoryGuidProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRecordHistoryIdentityProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordHistoryIdentity'",
+ "x-discriminator-value": "recordHistoryIdentity",
+ "x-discriminator-name": "propertyName"
+ },
+ "GsaRecordHistoryMoveException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordIdentityProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordIdentity'",
+ "x-discriminator-value": "recordIdentity",
+ "x-discriminator-name": "propertyName"
+ },
+ "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
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaStaticRecordLinkGroup\r\n * GsaDynamicRecordLinkGroup\r\n * GsaCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GsaStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GsaDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GsaRecordLinkGroupType": {
+ "enum": [
+ "static",
+ "dynamic",
+ "crossDatabase"
+ ],
+ "type": "string"
+ },
+ "GsaRecordLinkGroupsInfo": {
+ "type": "object",
+ "properties": {
+ "recordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimRecordLinkGroup"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListHeader": {
+ "required": [
+ "awaitingApproval",
+ "createdTimestamp",
+ "createdUser",
+ "identifier",
+ "internalUse",
+ "isRevision",
+ "lastModifiedTimestamp",
+ "lastModifiedUser",
+ "metadata",
+ "name",
+ "published"
+ ],
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "parentRecordListIdentifier": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdUser": {
+ "$ref": "#/components/schemas/GsaListsUserOrGroup"
+ },
+ "lastModifiedTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedUser": {
+ "$ref": "#/components/schemas/GsaListsUserOrGroup"
+ },
+ "publishedTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "publishedUser": {
+ "$ref": "#/components/schemas/GsaListsUserOrGroup"
+ },
+ "isRevision": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "published": {
+ "type": "boolean"
+ },
+ "awaitingApproval": {
+ "type": "boolean"
+ },
+ "internalUse": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListHeadersInfo": {
+ "required": [
+ "lists"
+ ],
+ "type": "object",
+ "properties": {
+ "lists": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaRecordListHeader"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListItemsInfo": {
+ "required": [
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaListItem"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListMemberCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordListIdentifiers": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRecordListPermissionFlags": {
+ "required": [
+ "isAdministrator",
+ "isCurator",
+ "isOwner",
+ "isPublisher",
+ "isSubscribed"
+ ],
+ "type": "object",
+ "properties": {
+ "isOwner": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an owner of this list."
+ },
+ "isSubscribed": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is subscribed to this list."
+ },
+ "isCurator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is a curator of this list."
+ },
+ "isAdministrator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an administrator of this list."
+ },
+ "isPublisher": {
+ "type": "boolean",
+ "description": "Flag indicating if this user or group is a publisher of this list."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListSearchCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaListCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "nameContains": {
+ "type": "string",
+ "nullable": true
+ },
+ "userRole": {
+ "$ref": "#/components/schemas/GsaUserRole"
+ },
+ "isPublished": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isAwaitingApproval": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isInternalUse": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "isRevision": {
+ "type": "boolean",
+ "description": "Restrict to record lists that are (non discarded) revisions.",
+ "nullable": true
+ },
+ "containsRecordsInDatabases": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing records in any of of the specified databases",
+ "nullable": true
+ },
+ "containsRecordsInIntegrationSchemas": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Limits results to lists containing records in any of the specified integration schemas",
+ "nullable": true
+ },
+ "containsRecordsInTables": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing records in any of the specified tables",
+ "nullable": true
+ },
+ "containsRecords": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "description": "Limits results to lists containing any of the given records",
+ "nullable": true
+ },
+ "userCanAddOrRemoveItems": {
+ "type": "boolean",
+ "description": "Limits results to lists where the current user can add or remove items.",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordList'",
+ "x-discriminator-value": "recordList",
+ "x-discriminator-name": "type"
+ },
+ "GsaRecordListSearchInfo": {
+ "required": [
+ "searchResultIdentifier"
+ ],
+ "type": "object",
+ "properties": {
+ "searchResultIdentifier": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListSearchRequest": {
+ "required": [
+ "searchCriterion"
+ ],
+ "type": "object",
+ "properties": {
+ "searchCriterion": {
+ "$ref": "#/components/schemas/GsaListCriterion"
+ },
+ "pagingOptions": {
+ "$ref": "#/components/schemas/GsaListsPagingOptions"
+ },
+ "responseOptions": {
+ "$ref": "#/components/schemas/GsaResponseOptions"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListSearchResult": {
+ "required": [
+ "header",
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "header": {
+ "$ref": "#/components/schemas/GsaRecordListHeader"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaListItem"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordListSearchResultsInfo": {
+ "required": [
+ "searchResults"
+ ],
+ "type": "object",
+ "properties": {
+ "searchResults": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaRecordListSearchResult"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordProperty": {
+ "enum": [
+ "recordIdentity",
+ "recordGuid",
+ "recordHistoryIdentity",
+ "recordHistoryGuid",
+ "tableIdentity",
+ "tableGuid",
+ "tableName",
+ "databaseKey",
+ "createdByUser",
+ "createdDate",
+ "lastModifiedByUser",
+ "lastModifiedDate",
+ "recordType",
+ "versionState",
+ "versionNumber",
+ "releasedDate",
+ "fullName",
+ "shortName",
+ "recordColor"
+ ],
+ "type": "string",
+ "description": "A record property represents data on a record that typically cannot be independently edited,\r\nas opposed to attribute data which may be edited on a record freely (albeit possibly requiring\r\nreleasing a new version). Record properties are usually tracked by the system automatically\r\nand are usually read-only.\r\nNote: for legacy reasons, some 'record properties' do not fall into these criteria, and do\r\nrepresent editable record fields more similar to attribute data. These record properties are\r\nusually exposed in this API as both 'record properties' and 'pseudo-attributes'."
+ },
+ "GsaRecordPropertyCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "required": [
+ "innerCriterion"
+ ],
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "#/components/schemas/GsaSearchableRecordProperty"
+ },
+ "innerCriterion": {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRecordPropertyInheritanceType": {
+ "enum": [
+ "none",
+ "fromParent",
+ "fromOriginalRecord"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the possible options for inheriting properties when copying or moving a record history."
+ },
+ "GsaRecordPropertySortCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSortCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "#/components/schemas/GsaSearchableRecordProperty"
+ },
+ "sortType": {
+ "$ref": "#/components/schemas/GsaSortType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Specifies a record property 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 'recordProperty'",
+ "x-discriminator-value": "recordProperty",
+ "x-discriminator-name": "type"
+ },
+ "GsaRecordReference": {
+ "required": [
+ "databaseKey"
+ ],
+ "type": "object",
+ "properties": {
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "databaseKey": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "The unique way to identify a record history (which may have multiple versions) in an MI system"
+ },
+ "GsaRecordReferenceCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "required": [
+ "databaseKey"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "Criterion that returns records matching a specific reference. The database key must be provided, along with either the record GUID or the record identity.\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"
+ },
+ "GsaRecordSubsetCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "subsetIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "subsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'subset'",
+ "x-discriminator-value": "subset",
+ "x-discriminator-name": "type"
+ },
+ "GsaRecordType": {
+ "enum": [
+ "record",
+ "generic",
+ "folder"
+ ],
+ "type": "string",
+ "description": "An API-level enum for the supported record types."
+ },
+ "GsaRecordTypeProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "recordType": {
+ "$ref": "#/components/schemas/GsaRecordType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRecordVersion": {
+ "required": [
+ "createdByUser",
+ "createdDate",
+ "databaseKey",
+ "guid",
+ "lastModifiedByUser",
+ "lastModifiedDate",
+ "name",
+ "recordColor",
+ "recordHistory",
+ "recordType",
+ "shortName",
+ "table",
+ "versionNumber",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "recordHistory": {
+ "$ref": "#/components/schemas/GsaSlimRecordHistory"
+ },
+ "table": {
+ "$ref": "#/components/schemas/GsaSlimTable"
+ },
+ "databaseKey": {
+ "type": "string"
+ },
+ "createdByUser": {
+ "type": "string"
+ },
+ "createdDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedByUser": {
+ "type": "string"
+ },
+ "lastModifiedDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "recordType": {
+ "$ref": "#/components/schemas/GsaRecordType"
+ },
+ "releasedDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "shortName": {
+ "type": "string"
+ },
+ "recordColor": {
+ "$ref": "#/components/schemas/GsaRecordColor"
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GsaVersionState"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRecordWithData": {
+ "required": [
+ "databaseKey"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataExportDatum"
+ },
+ "nullable": true
+ },
+ "properties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaReferencedByType": {
+ "enum": [
+ "expression",
+ "versionControlledData",
+ "dynamicLinkGroup",
+ "tabularAttribute",
+ "xyChartTemplate",
+ "searchMask",
+ "securityAttribute",
+ "attribute",
+ "data",
+ "defaultParameterValue"
+ ],
+ "type": "string"
+ },
+ "GsaReferentialIntegrityModel": {
+ "enum": [
+ "oneToOne",
+ "oneToMany",
+ "manyToMany"
+ ],
+ "type": "string"
+ },
+ "GsaReleaseRecordVersionControlException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaReleaseTableVersionControlException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaReleasedDateProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "releasedDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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\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
+ },
+ "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
+ },
+ "GsaResolvedLink": {
+ "required": [
+ "displayNames",
+ "guid",
+ "linkInfo",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GsaLinkAttributeType"
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "reverseDisplayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "linkInfo": {
+ "$ref": "#/components/schemas/GsaResolvedLinkInfo"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaResolvedLinkInfo": {
+ "required": [
+ "linkSource",
+ "linkTarget"
+ ],
+ "type": "object",
+ "properties": {
+ "linkSource": {
+ "$ref": "#/components/schemas/GsaResolvedLinkTarget"
+ },
+ "linkTarget": {
+ "$ref": "#/components/schemas/GsaResolvedLinkTarget"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaResolvedLinkTarget": {
+ "required": [
+ "databaseGuid",
+ "databaseVersionGuid",
+ "tableGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "databaseVersionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaResponseOptions": {
+ "type": "object",
+ "properties": {
+ "includeUserActions": {
+ "type": "boolean"
+ },
+ "includeUserPermissions": {
+ "type": "boolean"
+ },
+ "includeRecordListItems": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaResubmitJobRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "scheduledExecutionDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRichTextType": {
+ "enum": [
+ "plain",
+ "markdown"
+ ],
+ "type": "string",
+ "description": "The types of datum that are supported by the API.Possible values:
\r\n\r\n- Plain: Represents plain text.
\r\n- Markdown: (no description available)
\r\n
\r\n"
+ },
+ "GsaRichTextValue": {
+ "required": [
+ "text",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "type": {
+ "$ref": "#/components/schemas/GsaRichTextType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaRollupExportFailure": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaExportFailure"
+ },
+ {
+ "required": [
+ "failedRollup"
+ ],
+ "type": "object",
+ "properties": {
+ "failedRollup": {
+ "$ref": "#/components/schemas/GsaRollupReference"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaRollupReference": {
+ "required": [
+ "databaseKey",
+ "rollupType"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "attributeIdentity": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "attributeGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "rollupType": {
+ "$ref": "#/components/schemas/GsaTabularColumnRollUpType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSaveSearchRequest": {
+ "type": "object",
+ "properties": {
+ "searchConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "detail": {
+ "$ref": "#/components/schemas/GsaSearchDetail"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSearchClusterStatus": {
+ "type": "object",
+ "properties": {
+ "diskStatus": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/GsaDiskStatus"
+ },
+ "description": "The status of the disk compared to the Elasticsearch space thresholds.",
+ "nullable": true
+ },
+ "diskThreshold": {
+ "type": "string",
+ "description": "The 'flood stage' disk usage threshold from Elasticsearch. Elasticsearch enforces a read-only block on indexes once this is exceeded.",
+ "nullable": true
+ },
+ "diskThresholdMaxHeadroom": {
+ "type": "string",
+ "description": "The maximum headroom of the Elasticsearch 'flood stage'. If set, nodes with at least this amount of space will not be set as read-only even if they exceed the disk threshold",
+ "nullable": true
+ },
+ "clusterUnavailable": {
+ "type": "boolean",
+ "description": "True if the cluster could not be contacted.",
+ "nullable": true
+ }
+ },
+ "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": {
+ "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
+ },
+ "recordsThatFailedToIndex": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaIndexRecordFailure"
+ },
+ "description": "Details of any records that failed to index.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSearchMaskUsageDataModificationErrorDetail": {
+ "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\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'searchMask'",
+ "x-discriminator-value": "searchMask",
+ "x-discriminator-name": "referencedByType"
+ },
+ "GsaSearchRequest": {
+ "type": "object",
+ "properties": {
+ "criterion": {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ "sortCriteria": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSortCriterion"
+ },
+ "description": "An optional set of attribute based sort criteria. If none are provided, the results will be sorted in descending relevance order.",
+ "nullable": true
+ },
+ "pagingOptions": {
+ "$ref": "#/components/schemas/GsaPagingOptions"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSearchResponse": {
+ "required": [
+ "results"
+ ],
+ "type": "object",
+ "properties": {
+ "searchIdentifier": {
+ "type": "string",
+ "description": "If the search request had paging options specified, this will return an identifier that can be used to get the rest of the results",
+ "format": "uuid",
+ "nullable": true
+ },
+ "totalResultCount": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSearchResult"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSearchResult": {
+ "required": [
+ "databaseKey"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseKey": {
+ "type": "string"
+ },
+ "recordHistoryIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "recordIdentity": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "recordName": {
+ "type": "string",
+ "nullable": true
+ },
+ "treeName": {
+ "type": "string",
+ "nullable": true
+ },
+ "recordColor": {
+ "type": "string",
+ "nullable": true
+ },
+ "tableIdentity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "cubicSplineStatus": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionControlState": {
+ "type": "string",
+ "nullable": true
+ },
+ "versionNumber": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "parentIdentity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GsaRecordType"
+ },
+ "score": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "sortingValue": {
+ "$ref": "#/components/schemas/GsaSortingValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSearchResultsRequest": {
+ "type": "object",
+ "properties": {
+ "pageNumber": {
+ "type": "integer",
+ "description": "The (1-indexed) number of the page to return from a search\r\nThe size of the page was determined by the original query",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSearchableRecordProperty": {
+ "enum": [
+ "createdDate",
+ "creator",
+ "lastModifiedDate",
+ "lastModifier",
+ "recordType",
+ "color",
+ "versionState",
+ "versionNumber",
+ "recordName",
+ "treeName",
+ "databaseKey",
+ "tableName",
+ "tableIdentity"
+ ],
+ "type": "string",
+ "description": "Properties of a record that can be used to in searchesPossible 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
\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": [
+ {
+ "$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\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'securityAttribute'",
+ "x-discriminator-value": "securityAttribute",
+ "x-discriminator-name": "referencedByType"
+ },
+ "GsaSecurityGroups": {
+ "type": "object",
+ "properties": {
+ "readGroup": {
+ "type": "string",
+ "description": "Members of this groups can read data from the integration schema.",
+ "nullable": true
+ },
+ "adminGroup": {
+ "type": "string",
+ "description": "Members of this group can perform administrative tasks such as adding or deleting the schema.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false,
+ "description": "The security groups that apply to an integration schema. If null or empty, the default MI security groups will be used."
+ },
+ "GsaSelectionSearch": {
+ "type": "object",
+ "properties": {
+ "searchIdentifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "currentUserAccessInfo": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ },
+ "nullable": true
+ },
+ "criteria": {
+ "type": "string",
+ "nullable": true
+ },
+ "exploreConfig": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdUserOrGroup": {
+ "$ref": "#/components/schemas/GsaUserOrGroup"
+ },
+ "lastModifiedTimestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModifiedUserOrGroup": {
+ "$ref": "#/components/schemas/GsaUserOrGroup"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSeriesGraph": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaGraph"
+ },
+ {
+ "required": [
+ "constraintParameters",
+ "functionalType",
+ "numberOfPoints",
+ "xAxisParameter"
+ ],
+ "type": "object",
+ "properties": {
+ "functionalType": {
+ "$ref": "#/components/schemas/GsaFunctionalType"
+ },
+ "xAxisParameter": {
+ "$ref": "#/components/schemas/GsaSlimParameter"
+ },
+ "constraintParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimParameter"
+ }
+ },
+ "numberOfPoints": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "discriminator": {
+ "propertyName": "functionalType",
+ "mapping": {
+ "float": "#/components/schemas/GsaFloatSeriesGraph",
+ "discrete": "#/components/schemas/GsaDiscreteSeriesGraph"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetDateTimeDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetDatum": {
+ "required": [
+ "setDatumType"
+ ],
+ "type": "object",
+ "properties": {
+ "setDatumType": {
+ "$ref": "#/components/schemas/GsaSetDatumType"
+ }
+ },
+ "additionalProperties": false,
+ "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": {
+ "integer": "#/components/schemas/GsaSetIntegerDatum",
+ "logical": "#/components/schemas/GsaSetLogicalDatum",
+ "shortText": "#/components/schemas/GsaSetShortTextDatum",
+ "range": "#/components/schemas/GsaSetRangeDatum",
+ "datetime": "#/components/schemas/GsaSetDateTimeDatum",
+ "longText": "#/components/schemas/GsaSetLongTextDatum",
+ "hyperLink": "#/components/schemas/GsaSetHyperlinkDatum",
+ "point": "#/components/schemas/GsaSetPointDatum",
+ "discrete": "#/components/schemas/GsaSetDiscreteDatum",
+ "tabular": "#/components/schemas/GsaSetTabularDatum"
+ }
+ }
+ },
+ "GsaSetDatumType": {
+ "enum": [
+ "integer",
+ "logical",
+ "shortText",
+ "range",
+ "datetime",
+ "hyperLink",
+ "longText",
+ "point",
+ "discrete",
+ "tabular"
+ ],
+ "type": "string",
+ "description": "The types of datum dto that are supported by the API when creating or modifying data.Possible values:
\r\n\r\n- Integer: Integer
\r\n- Logical: Logical
\r\n- ShortText: Short Text
\r\n- Range: Range - in database units
\r\n- DateTime: DateTime
\r\n- HyperLink: Hyperlink
\r\n- LongText: Hyperlink
\r\n- Point: Point - in database units
\r\n- Discrete: Discrete
\r\n- Tabular: Tabular
\r\n
\r\n"
+ },
+ "GsaSetDiscreteDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "discreteValues"
+ ],
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetDiscreteParameterValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetParameterValue"
+ },
+ {
+ "required": [
+ "parameterValue"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValue": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetHyperlinkDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "address",
+ "description",
+ "target"
+ ],
+ "type": "object",
+ "properties": {
+ "address": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GsaHyperlinkTarget"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetIntegerDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetLogicalDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetLongTextDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "richTextValue"
+ ],
+ "type": "object",
+ "properties": {
+ "richTextValue": {
+ "$ref": "#/components/schemas/GsaRichTextValue"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetNumericParameterValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetParameterValue"
+ },
+ {
+ "required": [
+ "parameterValue"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValue": {
+ "type": "number",
+ "format": "double"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetParameterValue": {
+ "required": [
+ "parameterType"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterType": {
+ "$ref": "#/components/schemas/GsaParameterType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaSetDiscreteParameterValue\r\n * GsaSetNumericParameterValue",
+ "discriminator": {
+ "propertyName": "parameterType",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaSetDiscreteParameterValue",
+ "numeric": "#/components/schemas/GsaSetNumericParameterValue"
+ }
+ }
+ },
+ "GsaSetParameterWithValue": {
+ "required": [
+ "parameter",
+ "parameterValue"
+ ],
+ "type": "object",
+ "properties": {
+ "parameter": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "parameterValue": {
+ "$ref": "#/components/schemas/GsaSetParameterValue"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSetPointDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "estimated",
+ "values"
+ ],
+ "type": "object",
+ "properties": {
+ "estimated": {
+ "type": "boolean"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSetPointDatumValue"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetPointDatumValue": {
+ "required": [
+ "pointValue"
+ ],
+ "type": "object",
+ "properties": {
+ "pointValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "parametersAndValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSetParameterWithValue"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSetRangeDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "estimated",
+ "highValue",
+ "highValueIsInclusive",
+ "lowValue",
+ "lowValueIsInclusive"
+ ],
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "lowValueIsInclusive": {
+ "type": "boolean"
+ },
+ "highValueIsInclusive": {
+ "type": "boolean"
+ },
+ "estimated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetShortTextDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetTabularDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSetDatum"
+ },
+ {
+ "required": [
+ "rows"
+ ],
+ "type": "object",
+ "properties": {
+ "rows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSetTabularDatumRow"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSetTabularDatumRow": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "linkingValue": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaShortNameProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "shortName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaShortTextAggregation": {
+ "type": "object",
+ "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 extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'",
+ "x-discriminator-value": "shortText",
+ "x-discriminator-name": "datumType"
+ },
+ "GsaShortTextAggregationDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAggregationDatumCriterion"
+ },
+ {
+ "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
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'",
+ "x-discriminator-value": "shortText",
+ "x-discriminator-name": "type"
+ },
+ "GsaShortTextAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "required": [
+ "isUnique"
+ ],
+ "type": "object",
+ "properties": {
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ },
+ "dataRule": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaShortTextDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaShortTextDatumCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDatumCriterion"
+ },
+ {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "textMatchBehavior": {
+ "$ref": "#/components/schemas/GsaTextMatchBehavior"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaShortTextDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'",
+ "x-discriminator-value": "shortText",
+ "x-discriminator-name": "type"
+ },
+ "GsaShortTextPrefixDatumCriterion": {
+ "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 'shortTextPrefix'",
+ "x-discriminator-value": "shortTextPrefix",
+ "x-discriminator-name": "type"
+ },
+ "GsaSignificantFiguresInfo": {
+ "required": [
+ "enteredValue",
+ "significantFigures"
+ ],
+ "type": "object",
+ "properties": {
+ "significantFigures": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "enteredValue": {
+ "type": "number",
+ "format": "double"
+ },
+ "enteredUnit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSimpleAttributeToExport": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttributeToExport"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "rollUpType": {
+ "$ref": "#/components/schemas/GsaTabularColumnRollUpType"
+ },
+ "summaryRollUpType": {
+ "$ref": "#/components/schemas/GsaTabularColumnRollUpType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaSlimAttribute": {
+ "required": [
+ "displayNames",
+ "guid",
+ "isHiddenFromSearchCriteria",
+ "name",
+ "table",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "table": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimConfiguration": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimConstant": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "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"
+ ],
+ "type": "object",
+ "properties": {
+ "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
+ },
+ "GsaSlimEntity": {
+ "required": [
+ "guid"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimExpression": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimFile": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimLayout": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimLayoutSection": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaLayoutSection"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSlimNamedEntity": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimNamedUnit": {
+ "required": [
+ "guid",
+ "name",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "symbol": {
+ "type": "string"
+ },
+ "relativeSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimObjects": {
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimParameter": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaParameterType"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimProfile": {
+ "required": [
+ "isImplicit",
+ "key",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "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": "Profile stripped down to only the basic fields"
+ },
+ "GsaSlimProfileTable": {
+ "required": [
+ "databaseGuid",
+ "tableGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "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": "Profile table stripped to just the basic fields"
+ },
+ "GsaSlimRecordHistory": {
+ "required": [
+ "guid"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimRecordLinkGroup": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "reverseName",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "identity": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/GsaRecordLinkGroupType"
+ },
+ "reverseName": {
+ "type": "string"
+ },
+ "reverseDisplayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimRecordVersion": {
+ "required": [
+ "guid",
+ "name",
+ "versionNumber",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GsaVersionState"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimReplacementString": {
+ "required": [
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "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"
+ },
+ "GsaSlimSubset": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimTable": {
+ "required": [
+ "displayNames",
+ "guid",
+ "isHiddenFromBrowse",
+ "isHiddenFromSearch",
+ "isVersioned",
+ "name",
+ "tableTypes"
+ ],
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "isVersioned": {
+ "type": "boolean"
+ },
+ "tableTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimTypedAttribute": {
+ "required": [
+ "guid",
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimUnit": {
+ "required": [
+ "guid",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "relativeSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSlimUnitSystem": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Unit system stripped down to its basic fields (mappings excluded)."
+ },
+ "GsaSortCriterion": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "sortDirection": {
+ "$ref": "#/components/schemas/GsaSortDirection"
+ },
+ "type": {
+ "$ref": "#/components/schemas/GsaSortCriterionType"
+ }
+ },
+ "additionalProperties": false,
+ "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"
+ }
+ }
+ },
+ "GsaSortCriterionType": {
+ "enum": [
+ "attribute",
+ "recordProperty",
+ "relevance"
+ ],
+ "type": "string"
+ },
+ "GsaSortDirection": {
+ "enum": [
+ "ascending",
+ "descending"
+ ],
+ "type": "string"
+ },
+ "GsaSortType": {
+ "enum": [
+ "natural",
+ "alphabetical"
+ ],
+ "type": "string",
+ "description": "For a text-type sort, whether the results should use a pure alphabetical or a natural sort (where multi-digit numbers within strings are treated as a single character for the purposes of sorting)."
+ },
+ "GsaSortingValue": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaSortingValueType"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaDoubleSortingValue\r\n * GsaLongSortingValue\r\n * GsaStringSortingValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "double": "#/components/schemas/GsaDoubleSortingValue",
+ "long": "#/components/schemas/GsaLongSortingValue",
+ "text": "#/components/schemas/GsaStringSortingValue"
+ }
+ }
+ },
+ "GsaSortingValueType": {
+ "enum": [
+ "double",
+ "long",
+ "text"
+ ],
+ "type": "string"
+ },
+ "GsaSourceOfObjectIdentifier": {
+ "required": [
+ "mappings",
+ "table"
+ ],
+ "type": "object",
+ "properties": {
+ "database": {
+ "$ref": "#/components/schemas/GsaObjectIdentifier"
+ },
+ "databaseKey": {
+ "type": "string",
+ "nullable": true
+ },
+ "table": {
+ "$ref": "#/components/schemas/GsaObjectIdentifier"
+ },
+ "mappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaMappingOfObjectIdentifier"
+ },
+ "description": "Mappings for items from this table to the integration schema attributes."
+ }
+ },
+ "additionalProperties": false,
+ "description": "A source table from which integrated data will be taken."
+ },
+ "GsaSpecificValuesSpecifier": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaValueSpecifier"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "identities": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "guids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "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\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'specific'",
+ "x-discriminator-value": "specific",
+ "x-discriminator-name": "filterOn"
+ },
+ "GsaStandardName": {
+ "required": [
+ "databaseGuid",
+ "databaseKey",
+ "databaseVersionGuid",
+ "guid",
+ "mappedAttributes",
+ "mappedCrossDatabaseRecordLinkGroups",
+ "mappedParameters",
+ "mappedRecordLinkGroups",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ }
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "mappedRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "mappedCrossDatabaseRecordLinkGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "databaseKey": {
+ "type": "string"
+ },
+ "databaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "databaseVersionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaStandardNamesInfo": {
+ "type": "object",
+ "properties": {
+ "standardNames": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaStandardName"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaStaticRecordLinkGroup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaRecordLinkGroup"
+ },
+ {
+ "required": [
+ "includeIndirectLinks"
+ ],
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaStringSortingValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaSortingValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaSubset": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GsaSlimLayout"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaSubsetsInfo": {
+ "type": "object",
+ "properties": {
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimSubset"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTable": {
+ "required": [
+ "displayNames",
+ "guid",
+ "isHiddenFromBrowse",
+ "isHiddenFromSearch",
+ "isVersioned",
+ "layouts",
+ "name",
+ "subsets",
+ "tableTypes",
+ "versionState"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultSubset": {
+ "$ref": "#/components/schemas/GsaSlimSubset"
+ },
+ "subsets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimSubset"
+ }
+ },
+ "defaultLayout": {
+ "$ref": "#/components/schemas/GsaSlimLayout"
+ },
+ "layouts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimLayout"
+ }
+ },
+ "versionState": {
+ "$ref": "#/components/schemas/GsaVersionState"
+ },
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "isVersioned": {
+ "type": "boolean"
+ },
+ "tableTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTableDeletionException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTableGuidProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "tableGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaTableIdentityProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "tableIdentity": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaTableNameProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "tableName": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaTablesInfo": {
+ "type": "object",
+ "properties": {
+ "tables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimTable"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTabularAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaAttribute"
+ },
+ {
+ "required": [
+ "displayFullTable",
+ "displaySummaryRowInline",
+ "hideUnlinkedRows",
+ "tabularColumns"
+ ],
+ "type": "object",
+ "properties": {
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "target": {
+ "$ref": "#/components/schemas/GsaTabularAttributeTarget"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaTabularAttributeTarget": {
+ "type": "object",
+ "properties": {
+ "targetDatabaseGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetDatabaseVersionGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetTableGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "targetAttributeGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTabularAttributeUsageDataModificationErrorDetail": {
+ "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\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'tabularAttribute'",
+ "x-discriminator-value": "tabularAttribute",
+ "x-discriminator-name": "referencedByType"
+ },
+ "GsaTabularAttributeWithColumns": {
+ "required": [
+ "columns",
+ "tabularAttribute"
+ ],
+ "type": "object",
+ "properties": {
+ "tabularAttribute": {
+ "$ref": "#/components/schemas/GsaSlimAttribute"
+ },
+ "columns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTabularColumn": {
+ "required": [
+ "columnType",
+ "displayNames",
+ "guid",
+ "name",
+ "rollUpType",
+ "showAsLink",
+ "summaryRowEnabled",
+ "summaryRowRollUpType",
+ "summaryRowText"
+ ],
+ "type": "object",
+ "properties": {
+ "columnType": {
+ "$ref": "#/components/schemas/GsaTabularColumnDtoType"
+ },
+ "showAsLink": {
+ "type": "boolean"
+ },
+ "summaryRowEnabled": {
+ "type": "boolean"
+ },
+ "summaryRowText": {
+ "type": "string"
+ },
+ "rollUpType": {
+ "$ref": "#/components/schemas/GsaTabularColumnRollUpType"
+ },
+ "summaryRowRollUpType": {
+ "$ref": "#/components/schemas/GsaTabularColumnRollUpType"
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\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": {
+ "linkedAttribute": "#/components/schemas/GsaLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GsaLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GsaLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GsaLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GsaLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GsaLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GsaLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GsaLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GsaLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GsaLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GsaLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GsaLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GsaLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GsaLocalPictureTabularColumn",
+ "unavailable": "#/components/schemas/GsaUnavailableTabularColumn"
+ }
+ }
+ },
+ "GsaTabularColumnDtoType": {
+ "enum": [
+ "linkedAttribute",
+ "linkedRecord",
+ "linkedColumn",
+ "localInteger",
+ "localPoint",
+ "localRange",
+ "localLogical",
+ "localShortText",
+ "localLongText",
+ "localDateTime",
+ "localDiscrete",
+ "localHyperlink",
+ "localFile",
+ "localPicture",
+ "unavailable"
+ ],
+ "type": "string",
+ "description": "The types of tabular column."
+ },
+ "GsaTabularColumnRollUpType": {
+ "enum": [
+ "list",
+ "max",
+ "min",
+ "mean",
+ "stdDev",
+ "sum",
+ "count",
+ "countDistinct",
+ "listDistinct",
+ "coefficientOfVariation",
+ "chart"
+ ],
+ "type": "string",
+ "description": "The roll up types of a tabular column."
+ },
+ "GsaTabularDatum": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaApplicableDatum"
+ },
+ {
+ "required": [
+ "rows"
+ ],
+ "type": "object",
+ "properties": {
+ "rows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaTabularDatumRow"
+ }
+ },
+ "summaryRow": {
+ "$ref": "#/components/schemas/GsaTabularDatumSummaryRow"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaTabularDatumCell": {
+ "required": [
+ "column"
+ ],
+ "type": "object",
+ "properties": {
+ "column": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "cellDatum": {
+ "$ref": "#/components/schemas/GsaDatum"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Tabular datum cell. Datum endpoints are planned to only work with local tabular data,\r\nso this this datum cell is made with only local datum cells in mind."
+ },
+ "GsaTabularDatumExistsCriterion": {
+ "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\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabular'",
+ "x-discriminator-value": "tabular",
+ "x-discriminator-name": "type"
+ },
+ "GsaTabularDatumRollupCell": {
+ "required": [
+ "columnGuid"
+ ],
+ "type": "object",
+ "properties": {
+ "columnGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "datumRollup": {
+ "$ref": "#/components/schemas/GsaDatumRollup"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTabularDatumRow": {
+ "required": [
+ "cells",
+ "guid"
+ ],
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "cells": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaTabularDatumCell"
+ }
+ },
+ "linkingValue": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTabularDatumSummaryRow": {
+ "required": [
+ "cells"
+ ],
+ "type": "object",
+ "properties": {
+ "cells": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaTabularDatumRollupCell"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaTabularLinkingValueCriterion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaCriterion"
+ },
+ {
+ "required": [
+ "values"
+ ],
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "linkingValueMatchBehavior": {
+ "$ref": "#/components/schemas/GsaLinkingValueMatchBehavior"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaTabularRowExportBehavior": {
+ "enum": [
+ "allRows",
+ "onlyRowsWithVisibleLinkedRecords"
+ ],
+ "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"
+ },
+ "GsaTermWithCount": {
+ "type": "object",
+ "properties": {
+ "term": {
+ "type": "string",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A term from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GsaTextMatchBehavior": {
+ "enum": [
+ "contains",
+ "exactMatch",
+ "exactMatchCaseInsensitive"
+ ],
+ "type": "string"
+ },
+ "GsaUnavailableTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaTabularColumn"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUnit": {
+ "required": [
+ "guid",
+ "name",
+ "symbol"
+ ],
+ "type": "object",
+ "properties": {
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "symbol": {
+ "type": "string"
+ },
+ "relativeSymbol": {
+ "type": "string",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUnitEquivalent": {
+ "required": [
+ "equivalentUnit",
+ "unit",
+ "unitSystem"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaUnit"
+ },
+ "unitSystem": {
+ "$ref": "#/components/schemas/GsaUnitSystem"
+ },
+ "equivalentUnit": {
+ "$ref": "#/components/schemas/GsaUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUnitEquivalentsInfo": {
+ "type": "object",
+ "properties": {
+ "unitEquivalents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaUnitEquivalent"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUnitMapping": {
+ "required": [
+ "equivalentUnit",
+ "unit"
+ ],
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ },
+ "equivalentUnit": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUnitSystem": {
+ "required": [
+ "displayNames",
+ "guid",
+ "name",
+ "unitMappings"
+ ],
+ "type": "object",
+ "properties": {
+ "unitMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaUnitMapping"
+ }
+ },
+ "displayNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Unit system contains mappings from any unit to equivalent unit within this unit system.\r\nIf some unit comes from particular unit system it will be mapped to itself."
+ },
+ "GsaUnitSystemsInfo": {
+ "type": "object",
+ "properties": {
+ "unitSystems": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimUnitSystem"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUnitUsage": {
+ "required": [
+ "attributes",
+ "constants",
+ "expressions",
+ "parameters",
+ "units"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "constants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "expressions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedEntity"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimUnit"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUnitsInfo": {
+ "type": "object",
+ "properties": {
+ "units": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimNamedUnit"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateAllProfilesInfo": {
+ "type": "object",
+ "properties": {
+ "profiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "nullable": true
+ },
+ "defaultProfile": {
+ "$ref": "#/components/schemas/GsaUpdateDefaultProfile"
+ }
+ },
+ "additionalProperties": false,
+ "description": "Used to update the list of all profiles as well as default profile."
+ },
+ "GsaUpdateAttribute": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaAttributeType"
+ },
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "axisName": {
+ "type": "string",
+ "nullable": true
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "aboutAttribute": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "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 * 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": {
+ "point": "#/components/schemas/GsaUpdatePointAttribute",
+ "integer": "#/components/schemas/GsaUpdateIntegerAttribute",
+ "range": "#/components/schemas/GsaUpdateRangeAttribute",
+ "logical": "#/components/schemas/GsaUpdateLogicalAttribute",
+ "shortText": "#/components/schemas/GsaUpdateShortTextAttribute",
+ "longText": "#/components/schemas/GsaUpdateLongTextAttribute",
+ "dateTime": "#/components/schemas/GsaUpdateDateTimeAttribute",
+ "discrete": "#/components/schemas/GsaUpdateDiscreteAttribute",
+ "hyperlink": "#/components/schemas/GsaUpdateHyperlinkAttribute",
+ "file": "#/components/schemas/GsaUpdateFileAttribute",
+ "picture": "#/components/schemas/GsaUpdatePictureAttribute",
+ "link": "#/components/schemas/GsaUpdateTabularAttribute",
+ "floatFunctional": "#/components/schemas/GsaUpdateFloatFunctionalAttribute",
+ "discreteFunctional": "#/components/schemas/GsaUpdateDiscreteFunctionalAttribute",
+ "mathsFunctional": "#/components/schemas/GsaUpdateMathsFunctionalAttribute"
+ }
+ }
+ },
+ "GsaUpdateConfiguration": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "value": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateConstant": {
+ "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
+ },
+ "GsaUpdateContinuousRange": {
+ "type": "object",
+ "properties": {
+ "lowValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "highValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateCrossDatabaseRecordLinkGroup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDataRule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "regularExpression": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateDatabase": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "string",
+ "description": "The author of the database. Can only be edited by a database data administrator",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "description": "The company on the database. Can only be edited by a database data administrator",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "description": "The notes for the database. Can only be edited by a database data administrator",
+ "nullable": true
+ },
+ "currencyCode": {
+ "type": "string",
+ "description": "The currency code on the database. Can only be edited by a database data administrator",
+ "nullable": true
+ },
+ "versionGuid": {
+ "type": "string",
+ "description": "The version guid of the database. Can be edited by a database data administrator or a system administrator",
+ "format": "uuid"
+ },
+ "guid": {
+ "type": "string",
+ "description": "The unique identifier of the database. Can only be edited by a system administrator",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the database. 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"
+ },
+ "language": {
+ "type": "string",
+ "description": "The language of the database, used when indexing the database. Can only be edited by a system administrator",
+ "nullable": true
+ },
+ "databaseKey": {
+ "type": "string",
+ "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",
+ "nullable": true
+ },
+ "useIntegratedSecurity": {
+ "type": "boolean",
+ "description": "Set to true if the SQL connection to the database should use Windows authentication. Can only be edited by a system administrator",
+ "nullable": true
+ },
+ "sqlUserName": {
+ "type": "string",
+ "description": "The user name to use if the database should use SQL authentication. The password must also be provided. Can only be edited by a system administrator",
+ "nullable": true
+ },
+ "sqlPassword": {
+ "type": "string",
+ "description": "The password name to use if the database should use SQL authentication. Can only be edited by a system administrator",
+ "nullable": true
+ },
+ "initialCatalog": {
+ "type": "string",
+ "description": "The name of the database in SQL server. Can only be edited by a system administrator",
+ "nullable": true
+ },
+ "additionalSqlParameters": {
+ "type": "string",
+ "description": "Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. Can only be edited by a system administrator",
+ "nullable": true
+ },
+ "loadingOrder": {
+ "type": "integer",
+ "description": "The MI loading order for the database. Can only be edited by a system administrator",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateDateTimeAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDefaultProfile": {
+ "required": [
+ "key"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key is a unique identifier of a profile. Separate from guid."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateDiscreteAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "isMultiValued": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDiscreteFunctionalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteFunctionalAttributeParameter"
+ }
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDiscreteFunctionalAttributeDiscreteParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaUpdateDiscreteFunctionalAttributeNumericParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDiscreteFunctionalAttributeParameter": {
+ "required": [
+ "parameterGuid",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaParameterType"
+ },
+ "parameterGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaUpdateDiscreteFunctionalAttributeNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaUpdateDiscreteFunctionalAttributeDiscreteParameter",
+ "numeric": "#/components/schemas/GsaUpdateDiscreteFunctionalAttributeNumericParameter"
+ }
+ }
+ },
+ "GsaUpdateDiscreteParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateParameter"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDiscreteParameterContent": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "parameterValue": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GsaUpdateDiscreteRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDiscreteParameterValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateDiscreteRange": {
+ "required": [
+ "parameterValues"
+ ],
+ "type": "object",
+ "properties": {
+ "parameterValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateDiscreteType": {
+ "type": "object",
+ "properties": {
+ "isOrdered": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateDynamicRecordLinkGroup": {
+ "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"
+ }
+ }
+ }
+ }
+ ],
+ "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",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateFile": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateFileAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateFloatFunctionalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaUpdateFloatFunctionalAttributeParameter"
+ }
+ },
+ "isRange": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateFloatFunctionalAttributeDiscreteParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateFloatFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaUpdateFloatFunctionalAttributeNumericParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateFloatFunctionalAttributeParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultValue": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "interpolationMethod": {
+ "$ref": "#/components/schemas/GsaAttributeInterpolationMethod"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GsaAttributeScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaUpdateFloatFunctionalAttributeParameter": {
+ "required": [
+ "parameterGuid",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaParameterType"
+ },
+ "parameterGuid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateFloatFunctionalAttributeDiscreteParameter\r\n * GsaUpdateFloatFunctionalAttributeNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaUpdateFloatFunctionalAttributeDiscreteParameter",
+ "numeric": "#/components/schemas/GsaUpdateFloatFunctionalAttributeNumericParameter"
+ }
+ }
+ },
+ "GsaUpdateFolder": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateHyperlinkAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateIntegerAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "isUnique": {
+ "type": "boolean",
+ "description": "Whether or not the attribute is constrained to contain a unique value"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateJobRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "scheduledExecutionDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/GsaJobStatus"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateLayout": {
+ "type": "object",
+ "properties": {
+ "applicableApplications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "If there are no ApplicableApplications, the layout is applicable in all applications.",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateLinkedAttributeTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "linkedAttribute": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLinkedColumnTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "linkedColumn": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLinkedRecordTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalDateTimeTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalDiscreteTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "discreteType": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalFileTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalHyperlinkTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalIntegerTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalLogicalTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalLongTextTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalPictureTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalPointTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalRangeTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ },
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLocalShortTextTabularColumn": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "defaultThresholdType": {
+ "$ref": "#/components/schemas/GsaAttributeThresholdType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLogicalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateLongTextAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateMathsContent": {
+ "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/GsaUpdateParameterContent"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateMathsFunctionalAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "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"
+ },
+ "isRange": {
+ "type": "boolean"
+ },
+ "defaultContent": {
+ "$ref": "#/components/schemas/GsaUpdateMathsContent"
+ },
+ "allowAllCompatibleExpressions": {
+ "type": "boolean"
+ },
+ "allowAnonymousExpressions": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateNumericParameter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateParameter"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "interpolationType": {
+ "$ref": "#/components/schemas/GsaParameterInterpolationType"
+ },
+ "scaleType": {
+ "$ref": "#/components/schemas/GsaParameterScaleType"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateNumericParameterContent": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateParameterContent"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "parameterRange": {
+ "$ref": "#/components/schemas/GsaUpdateContinuousRange"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateNumericParameterValue": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateParameterValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateParameter": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/GsaParameterType"
+ },
+ "helpPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "defaultParameterValueGuid": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteParameter\r\n * GsaUpdateNumericParameter",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaUpdateDiscreteParameter",
+ "numeric": "#/components/schemas/GsaUpdateNumericParameter"
+ }
+ }
+ },
+ "GsaUpdateParameterContent": {
+ "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 * GsaUpdateDiscreteParameterContent\r\n * GsaUpdateNumericParameterContent",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaUpdateDiscreteParameterContent",
+ "numeric": "#/components/schemas/GsaUpdateNumericParameterContent"
+ }
+ }
+ },
+ "GsaUpdateParameterValue": {
+ "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 * GsaUpdateDiscreteParameterValue\r\n * GsaUpdateNumericParameterValue",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "discrete": "#/components/schemas/GsaUpdateDiscreteParameterValue",
+ "numeric": "#/components/schemas/GsaUpdateNumericParameterValue"
+ }
+ }
+ },
+ "GsaUpdatePictureAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdatePointAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "isMultiValued": {
+ "type": "boolean"
+ },
+ "attributeParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateProfile": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "homepageUrl": {
+ "type": "string",
+ "nullable": true
+ },
+ "profileTableGuids": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "description": "Guid is a unique identifier of a profile. Separate from key.",
+ "format": "uuid",
+ "nullable": true
+ },
+ "groupName": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A profile, consisting of a set of tables from one or more databases."
+ },
+ "GsaUpdateProfileTable": {
+ "type": "object",
+ "properties": {
+ "subsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "layoutGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A table within a profile. Contains display customization."
+ },
+ "GsaUpdateRangeAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "unit": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateRecordLinkGroup": {
+ "required": [
+ "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 * GsaUpdateStaticRecordLinkGroup\r\n * GsaUpdateDynamicRecordLinkGroup\r\n * GsaUpdateCrossDatabaseRecordLinkGroup",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "static": "#/components/schemas/GsaUpdateStaticRecordLinkGroup",
+ "dynamic": "#/components/schemas/GsaUpdateDynamicRecordLinkGroup",
+ "crossDatabase": "#/components/schemas/GsaUpdateCrossDatabaseRecordLinkGroup"
+ }
+ }
+ },
+ "GsaUpdateRecordListPermissionFlags": {
+ "required": [
+ "isAdministrator",
+ "isCurator",
+ "isPublisher",
+ "isSubscribed"
+ ],
+ "type": "object",
+ "properties": {
+ "isSubscribed": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is subscribed to this list."
+ },
+ "isCurator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is a curator of this list."
+ },
+ "isAdministrator": {
+ "type": "boolean",
+ "description": "Flag indicating if the user or group is an administrator of this list."
+ },
+ "isPublisher": {
+ "type": "boolean",
+ "description": "Flag indicating if this user or group is a publisher of this list."
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateRecordListProperties": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "notes": {
+ "type": "string",
+ "nullable": true
+ },
+ "published": {
+ "type": "boolean"
+ },
+ "awaitingApproval": {
+ "type": "boolean"
+ },
+ "internalUse": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateReplacementString": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateShortTextAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "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: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'",
+ "x-discriminator-value": "shortText",
+ "x-discriminator-name": "type"
+ },
+ "GsaUpdateStandardName": {
+ "type": "object",
+ "properties": {
+ "mappedAttributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "nullable": true
+ },
+ "mappedParameters": {
+ "type": "array",
+ "items": {
+ "$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
+ },
+ "GsaUpdateStaticRecordLinkGroup": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "includeIndirectLinks": {
+ "type": "boolean"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUpdateSubset": {
+ "type": "object",
+ "properties": {
+ "associatedLayout": {
+ "$ref": "#/components/schemas/GsaSlimEntity"
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateTable": {
+ "type": "object",
+ "properties": {
+ "isHiddenFromBrowse": {
+ "type": "boolean"
+ },
+ "isHiddenFromSearch": {
+ "type": "boolean"
+ },
+ "defaultSubsetGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "defaultLayoutGuid": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateTabularAttribute": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUpdateAttribute"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "displayFullTable": {
+ "type": "boolean"
+ },
+ "displaySummaryRowInline": {
+ "type": "boolean"
+ },
+ "hideUnlinkedRows": {
+ "type": "boolean"
+ },
+ "tabularColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaUpdateTabularColumn"
+ },
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "description": "\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"
+ },
+ "GsaUpdateTabularColumn": {
+ "required": [
+ "columnType"
+ ],
+ "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": "\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",
+ "discriminator": {
+ "propertyName": "columnType",
+ "mapping": {
+ "linkedAttribute": "#/components/schemas/GsaUpdateLinkedAttributeTabularColumn",
+ "linkedColumn": "#/components/schemas/GsaUpdateLinkedColumnTabularColumn",
+ "linkedRecord": "#/components/schemas/GsaUpdateLinkedRecordTabularColumn",
+ "localPoint": "#/components/schemas/GsaUpdateLocalPointTabularColumn",
+ "localRange": "#/components/schemas/GsaUpdateLocalRangeTabularColumn",
+ "localInteger": "#/components/schemas/GsaUpdateLocalIntegerTabularColumn",
+ "localLogical": "#/components/schemas/GsaUpdateLocalLogicalTabularColumn",
+ "localShortText": "#/components/schemas/GsaUpdateLocalShortTextTabularColumn",
+ "localLongText": "#/components/schemas/GsaUpdateLocalLongTextTabularColumn",
+ "localDateTime": "#/components/schemas/GsaUpdateLocalDateTimeTabularColumn",
+ "localDiscrete": "#/components/schemas/GsaUpdateLocalDiscreteTabularColumn",
+ "localHyperlink": "#/components/schemas/GsaUpdateLocalHyperlinkTabularColumn",
+ "localFile": "#/components/schemas/GsaUpdateLocalFileTabularColumn",
+ "localPicture": "#/components/schemas/GsaUpdateLocalPictureTabularColumn"
+ }
+ }
+ },
+ "GsaUpdateUnit": {
+ "type": "object",
+ "properties": {
+ "symbol": {
+ "type": "string"
+ },
+ "equation": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateUnitSystem": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "guid": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateUserPermission": {
+ "required": [
+ "flags",
+ "userOrGroupIdentifier"
+ ],
+ "type": "object",
+ "properties": {
+ "userOrGroupIdentifier": {
+ "type": "string",
+ "description": "The user or group identifier",
+ "format": "uuid"
+ },
+ "flags": {
+ "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUpdateUserPermissionsInfo": {
+ "required": [
+ "userPermissions"
+ ],
+ "type": "object",
+ "properties": {
+ "userPermissions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaUpdateUserPermission"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUsageDataModificationErrorDetail": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaDataModificationErrorDetail"
+ },
+ {
+ "required": [
+ "referencedByType"
+ ],
+ "type": "object",
+ "properties": {
+ "referencedByType": {
+ "$ref": "#/components/schemas/GsaReferencedByType"
+ }
+ },
+ "discriminator": {
+ "propertyName": "referencedByType",
+ "mapping": {
+ "expression": "#/components/schemas/GsaExpressionUsageDataModificationErrorDetail",
+ "versionControlledData": "#/components/schemas/GsaVersionControlledDataUsageDataModificationErrorDetail",
+ "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"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaUserOrGroup": {
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "displayName": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUserPermission": {
+ "required": [
+ "flags",
+ "userOrGroupIdentifier",
+ "userOrGroupName"
+ ],
+ "type": "object",
+ "properties": {
+ "userOrGroupName": {
+ "type": "string",
+ "description": "The user or group name."
+ },
+ "userOrGroupIdentifier": {
+ "type": "string",
+ "description": "The user or group identifier",
+ "format": "uuid"
+ },
+ "flags": {
+ "$ref": "#/components/schemas/GsaRecordListPermissionFlags"
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUserPermissionsInfo": {
+ "required": [
+ "userPermissions"
+ ],
+ "type": "object",
+ "properties": {
+ "userPermissions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaUserPermission"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaUserRole": {
+ "enum": [
+ "None",
+ "Owner",
+ "Subscriber",
+ "Curator",
+ "Administrator",
+ "Publisher"
+ ],
+ "type": "string",
+ "description": "A set of flags that can be used to describe the role or roles that a user has on a particular record list"
+ },
+ "GsaValidateAttributeRequest": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The value to check an attributes data validation rules against",
+ "nullable": true
+ },
+ "recordHistoryGuid": {
+ "type": "string",
+ "description": "The record you want to check the value against to see if the value has changed as well as being valid",
+ "format": "uuid",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaValueSpecifier": {
+ "required": [
+ "filterOn"
+ ],
+ "type": "object",
+ "properties": {
+ "filterOn": {
+ "$ref": "#/components/schemas/GsaValueSpecifierType"
+ }
+ },
+ "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\r\n * GsaExcludeValuesSpecifier\r\n * GsaSpecificValuesSpecifier\r\n * GsaNoValuesSpecifier",
+ "discriminator": {
+ "propertyName": "filterOn",
+ "mapping": {
+ "all": "#/components/schemas/GsaAllValuesSpecifier",
+ "exclude": "#/components/schemas/GsaExcludeValuesSpecifier",
+ "specific": "#/components/schemas/GsaSpecificValuesSpecifier",
+ "none": "#/components/schemas/GsaNoValuesSpecifier"
+ }
+ }
+ },
+ "GsaValueSpecifierType": {
+ "enum": [
+ "all",
+ "exclude",
+ "specific",
+ "none"
+ ],
+ "type": "string",
+ "description": "Types of ValueSpecifier allowed in requests.\r\nUsed by ValueSpecifier to specify whether we want all identities, some guids, exclude some identities, etc."
+ },
+ "GsaValueWithCountOfBoolean": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "boolean"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GsaValueWithCountOfGuid": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GsaValueWithCountOfInt32": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false,
+ "description": "A value from the search index, along with a count of how many times it occurs in some scope."
+ },
+ "GsaVersionControlErrorDetail": {
+ "required": [
+ "message",
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "description": "\r\n\r\nThis is one of: \r\n * GsaInvalidVersionStateErrorDetail\r\n * GsaNotTheLatestVersionErrorDetail\r\n * GsaInvalidParentStateErrorDetail\r\n * GsaNotVersionedErrorDetail",
+ "discriminator": {
+ "propertyName": "reason",
+ "mapping": {
+ "invalidVersionState": "#/components/schemas/GsaInvalidVersionStateErrorDetail",
+ "notTheLatestVersion": "#/components/schemas/GsaNotTheLatestVersionErrorDetail",
+ "invalidParentState": "#/components/schemas/GsaInvalidParentStateErrorDetail",
+ "notVersioned": "#/components/schemas/GsaNotVersionedErrorDetail"
+ }
+ }
+ },
+ "GsaVersionControlledDataUsageDataModificationErrorDetail": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaVersionNumberProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "versionNumber": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaVersionState": {
+ "enum": [
+ "unversioned",
+ "unreleased",
+ "released",
+ "superseded",
+ "withdrawn"
+ ],
+ "type": "string",
+ "description": "API-level enum for version control state."
+ },
+ "GsaVersionStateProperty": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsaProperty"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "versionState": {
+ "$ref": "#/components/schemas/GsaVersionState"
+ }
+ }
+ }
+ ],
+ "additionalProperties": false,
+ "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"
+ },
+ "GsaWithdrawRecordVersionControlException": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "code": {
+ "$ref": "#/components/schemas/SystemNetHttpStatusCode"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GsaVersionControlErrorDetail"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "GsaXYChartTemplateUsageDataModificationErrorDetail": {
+ "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\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'xyChartTemplate'",
+ "x-discriminator-value": "xyChartTemplate",
+ "x-discriminator-name": "referencedByType"
+ },
+ "JsonPatchDocument": {
+ "type": "object",
+ "properties": {
+ "op": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "MicrosoftAspNetCoreMvcFormattersIOutputFormatter": {
+ "type": "object",
+ "additionalProperties": false
+ },
+ "MicrosoftAspNetCoreMvcObjectResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "object",
+ "nullable": true
+ },
+ "formatters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcFormattersIOutputFormatter"
+ },
+ "nullable": true
+ },
+ "contentTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "declaredType": {
+ "type": "string",
+ "nullable": true
+ },
+ "statusCode": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "SystemNetHttpStatusCode": {
+ "enum": [
+ 100,
+ 101,
+ 200,
+ 201,
+ 202,
+ 203,
+ 204,
+ 205,
+ 206,
+ 300,
+ 301,
+ 302,
+ 303,
+ 304,
+ 305,
+ 306,
+ 307,
+ 400,
+ 401,
+ 402,
+ 403,
+ 404,
+ 405,
+ 406,
+ 407,
+ 408,
+ 409,
+ 410,
+ 411,
+ 412,
+ 413,
+ 414,
+ 415,
+ 416,
+ 417,
+ 426,
+ 500,
+ 501,
+ 502,
+ 503,
+ 504,
+ 505
+ ],
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+}
\ No newline at end of file