From a1094fe1fa4e077793ff5755e16b7f39bd483f6f Mon Sep 17 00:00:00 2001 From: Viet Le Date: Wed, 18 Oct 2023 11:15:00 -0500 Subject: [PATCH 01/11] add Cognite Data Fusion --- .../Cognite Data Fusion/Readme.md | 286 + .../apiDefinition.swagger.json | 15415 ++++++++++++++++ .../Cognite Data Fusion/apiProperties.json | 36 + 3 files changed, 15737 insertions(+) create mode 100644 certified-connectors/Cognite Data Fusion/Readme.md create mode 100644 certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json create mode 100644 certified-connectors/Cognite Data Fusion/apiProperties.json diff --git a/certified-connectors/Cognite Data Fusion/Readme.md b/certified-connectors/Cognite Data Fusion/Readme.md new file mode 100644 index 0000000000..1ba5e8fc51 --- /dev/null +++ b/certified-connectors/Cognite Data Fusion/Readme.md @@ -0,0 +1,286 @@ +## Cognite Data Fusion Connector +Connect to your Cognite Data Fusion project using the Cognite Data Fusion API endpoints found at https://api-docs.cognite.com/ + +Documentation: https://docs.cognite.com/ +Developer: https://developer.cognite.com/ + +## Cognite + +## Prerequisites +You will need the following to proceed: +* A Microsoft Power Apps or Power Automate plan with custom connector feature +* An Azure subscription +* A Cognite Data Fusion Project +* OAuth2 configured with your Cognite Data Fusion Project (see below) + +## Supported Operations +* List time series +* Create time series +* Retrieve time series +* Filter time series +* Aggregate time series +* Search time series +* Update time series +* Delete time series +* Insert data points +* Retrieve data points +* Retrieve latest data point +* Delete data points +* Create or update spaces +* List spaces defined in the project +* Retrieve spaces by their space-ids +* Delete spaces +* Create or update data models +* List data models defined in the project +* Filter data models +* Retrieve data models by their external ids +* Delete data models +* Create or update views +* List views defined in the project +* Retrieve views by their external ids +* Delete views +* Create or update containers +* List containers defined in the project +* Retrieve containers by their external ids +* Delete containers +* Delete indexes from containers +* Delete constraints from containers +* Create or update nodes or edges +* Filter nodes or edges +* Retrieve nodes or edges by their external ids +* Search for nodes or edges +* Aggregate data across nodes or edges +* Delete nodes or edges +* Query nodes or edges +* Sync nodes or edges +* Query_GraphQL + +### List time series +List time series. Use `nextCursor` to paginate through the results. + +### Create time series +Creates one or more time series. + +### Retrieve time series +Retrieves one or more time series by ID or external ID. The response returns the time series in the same order as in the request. + +### Filter time series +Retrieves a list of time series that match the given criteria. + +### Aggregate time series +The aggregation API allows you to compute aggregated results from a set of time series, such as +getting the number of time series in a project or checking what assets the different time series +in your project are associated with (along with the number of time series for each asset). +By specifying `filter` and/or `advancedFilter`, the aggregation will take place only over those +time series that match the filters. `filter` and `advancedFilter` behave the same way as in the +`list` endpoint. + + +### Search time series +Fulltext search for time series based on result relevance. Primarily meant +for human-centric use cases, not for programs, since matching and +order may change over time. Additional filters can also be +specified. This operation does not support pagination. + +### Update time series +Updates one or more time series. Fields outside of the request remain unchanged. + +For primitive fields (those whose type is string, number, or boolean), use `"set": value` +to update the value; use `"setNull": true` to set the field to null. + +For JSON array fields (for example `securityCategories`), use `"set": [value1, value2]` to +update the value; use `"add": [value1, value2]` to add values; use +`"remove": [value1, value2]` to remove values. + +### Delete time series +Deletes the time series with the specified IDs and their data points. + +### Insert data points +Insert data points into a time series. You can do this for multiple time series. +If you insert a data point with a timestamp that already exists, it will be overwritten with the new value. + +### Retrieve data points +Retrieves a list of data points from multiple time series in a project. +This operation supports aggregation and pagination. +Learn more about [aggregation](). + +Note: when `start` isn't specified in the top level and for an individual item, it will default to epoch 0, which is 1 January, 1970, thus +excluding potential existent data points before 1970. `start` needs to be specified as a negative number to get data points before 1970. + +### Retrieve latest data point +Retrieves the latest data point in one or more time series. Note that the latest data point +in a time series is the one with the highest timestamp, which is not necessarily the one +that was ingested most recently. + + +### Delete data points +Delete data points from time series. + +### Create or update spaces +Add or update (upsert) spaces. For unchanged space specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for spaces that remain unchanged. + +### List spaces defined in the project +List spaces defined in the current project. + +### Retrieve spaces by their space-ids +Retrieve up to 100 spaces by specifying their space-ids. + +### Delete spaces +Delete one or more spaces. Currently limited to 100 spaces at a time. + + +If an existing data model references a space, you cannot delete that space. Nodes, edges and other data types that are part of a space will no longer be available. + +### Create or update data models +Add or update (upsert) data models. For unchanged data model specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for models that remain unchanged. + +### List data models defined in the project +List data models defined in the project. You can filter the returned models by the specified space. + +### Filter data models +List data models in a project when they match a given filter. + +### Retrieve data models by their external ids +Retrieve up to 100 data models by their external ids. Views can be auto-expanded when the ```InlineViews``` query parameter is set. + +### Delete data models +Delete one or more data models. Currently limited to 100 models at a time. This does not delete the views, nor the containers they reference. + +### Create or update views +Add or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for views that remain unchanged. + +### List views defined in the project +List of views defined in the current project. You can filter the list by specifying a space. + +### Retrieve views by their external ids +Retrieve up to 100 views by their external ids. + +### Delete views +Delete one or more views. Currently limited to 100 views at a time. The service cannot delete a view referenced by a data model. + +### Create or update containers +Add or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for containers that remain unchanged. + +### List containers defined in the project +List of containers defined in the current project. You can filter the list by specifying a space. + +### Retrieve containers by their external ids +Retrieve up to 100 containers by their specified external ids. + +### Delete containers +Delete one or more containers. Currently limited to 100 containers at a time. You cannot delete a container when one or more data model(s) or view(s) references it. + +### Delete indexes from containers +Delete one or more container indexes. Currently limited to 10 indexes at a time. + +### Delete constraints from containers +Delete one or more container constraints. Currently limited to 10 constraints at a time. + +### Create or update nodes/edges +Create or update nodes and edges in a transaction. The ```items``` field of the payload is an array of objects +where each object describes a node or an edge to create, patch or replace. The ```instanceType``` field of +each object must be ```node``` or ```edge``` and determines how the rest of the object is interpreted. + +This operation is currently limited to 1000 nodes and/or edges at a time. + +Individual nodes and edges are uniquely identified by their externalId and space. + +### Creating new instances +When there is no node or edge with the given externalId in the given space, a node will be created and the +properties provided for each of the containers or views in the ```sources``` array will be populated for the +node/edge. Nodes can also be created implicitly when an edge between them is created (if +```autoCreateStartNodes``` and/or ``` autoCreateEndNodes``` is set), or when a direct relation +property is set, the target node does not exist and ```autoCreateDirectRelations``` is set. + +To add a node or edge, the user must have capabilities to access (write to) both the view(s) referenced in +```sources``` and the container(s) underlying these views, as well as any directly referenced containers. + +### Filter nodes/edges +Filter the instances - nodes and edges - in a project. + +### Retrieve nodes/edges by their external ids +Retrieve up to 1000 nodes or edges by their external ids. + +### Search for nodes/edges +Search text fields in views for nodes or edge(s). The service will return up to 1000 results. This operation orders the results by relevance, across the specified spaces. + +### Aggregate data across nodes/edges +Aggregate data for nodes or edges in a project. You can use an optional query or filter specification to limit the result. + +### Delete nodes/edges +Delete nodes and edges in a transaction. Limited to 1000 nodes/edges at a time. + + +When a node is selected for deletion, all connected incoming and outgoing edges that point to or from it are also deleted. However, please note that the operation might fail if the node has a high number of edge connections. If this is the case, consider deleting the edges connected to the node before deleting the node itself. + +### Query nodes/edges +The Data Modelling API exposes an advanced query interface. The query interface supports parameterization, +recursive edge traversal, chaining of result sets, and granular property selection. + +A query is composed of a with section defining result set expressions that describe the input to the query, +a set of optional parameter placeholders if the query is parameterized, and then the select section that defines +which properties are to be returned back as part of the result. + +Imagine you have a data set with airplanes and airports, represented as two sets of nodes with edges between them +indicating in which airports the airplanes land. Here is an example of a query which fetches a specific airplane as +well as the airports it lands in: + +```yaml +with: + airplanes: + nodes: + filter: + equals: + property: ["node", "externalId"] + value: {"parameter": "airplaneExternalId"} + limit: 1 + lands_in_airports: + edges: + from: airplanes + maxDistance: 1 + direction: outwards + filter: + equals: + property: ["edge", "type"] + value: ["aviation", "lands-in"] + airports: + nodes: + from: lands_in_airports +parameters: + airplaneExternalId: myFavouriteAirplane +select: + airplanes: {} + airports: {} +``` + +### Sync nodes/edges +Subscribe to changes for nodes and edges in a project, matching a supplied filter. This endpoint will always return a ```NextCursor```. The sync specification mirrors the query interface, but sorting is not currently supported. + +## Obtaining Credentials +Since Cognitedata APIs are secured by Azure Active Directory (AD), we first need to set up a few thing in Azure AD so that our connectors can securely access the Cognite API. After that is completed, you can create and test the sample connector. + +### Set up an Azure AD application for your custom connector +We first need to register our connector as an application in Azure AD. This will allow the connector to identify itself to Azure AD so that it can ask for permissions to access Cognite data on behalf of the end user. You can read more about this [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/authentication-scenarios) and follow the steps below: + +1. Create an Azure AD application +This Azure AD application will be used to identify the connector to the Cognite API. This can be done using [Azure Portal] (https://portal.azure.com), by following the steps [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app). Once created, note down the value of Application (Client) ID. You will need this later. + +2. Configure (Update) your Azure AD application to access the Cognitedata API +This step will ensure that your application can successfully retrieve an access token to invoke Cognitedata API on behalf of your users. To do this, follow the steps [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-configure-app-access-web-apis). + - For redirect URI, use “https://global.consent.azure-apim.net/redirect” + - For the credentials, use a client secret (and not certificates). Remember to note the secret down, you will need this later and it is shown only once. + - For API permissions, make sure “Cognitedata API: ” and “user_impersonation” are added. + +At this point, we now have a valid Azure AD application that can be used to get permissions from end users and access Cognitedata API. The next step for us is to create a custom connector. + +## Known Issues and Limitations +This is a partial connector containing only the Time Series and Data Modeling endpoints to the Cognite Data Fusion API. + +## Deployment Instructions +Run the following commands and follow the prompts: + +```paconn +paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret +``` +### NOTE +> Make sure that the PLACEHOLDER variables are updated in apiProperties.json diff --git a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json new file mode 100644 index 0000000000..30e2f12226 --- /dev/null +++ b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json @@ -0,0 +1,15415 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0.0", + "title": "Cognite Data Fusion", + "description": "Connect to your Cognite Data Fusion project using the Cognite Data Fusion API endpoints found at https://api-docs.cognite.com/\nDocumentation: https://docs.cognite.com/ Developer: https://developer.cognite.com/", + "contact": { + "name": "Cognite Support", + "url": "https://support.cognite.com", + "email": "support@cognite.com" + } + }, + "host": "bluefield.cognitedata.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "paths": { + "/api/v1/projects/{project}/timeseries": { + "get": { + "summary": "List time series", + "description": "List time series. Use `nextCursor` to paginate through the results.", + "operationId": "ListTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "limit", + "default": 100, + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000, + "required": false + }, + { + "name": "includeMetadata", + "default": true, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "cursor", + "in": "query", + "type": "string", + "required": false + }, + { + "name": "partition", + "in": "query", + "type": "string", + "required": false + }, + { + "name": "assetIds", + "in": "query", + "type": "string", + "description": "[363848954441724, 793045462540095, 1261042166839739]", + "required": false + }, + { + "name": "rootAssetIds", + "in": "query", + "type": "string", + "description": "[363848954441724, 793045462540095, 1261042166839739]", + "required": false + }, + { + "name": "externalIdPrefix", + "in": "query", + "type": "string", + "maxLength": 255, + "required": false + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "name": { + "type": "string", + "description": "name" + }, + "metadata": { + "type": "object", + "properties": { + "tempord": { + "type": "string", + "description": "tempord" + }, + "eiusmod_0_3": { + "type": "string", + "description": "eiusmod_0_3" + }, + "auteb": { + "type": "string", + "description": "auteb" + } + }, + "description": "metadata" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "assetId": { + "type": "integer", + "format": "int32", + "description": "assetId" + }, + "description": { + "type": "string", + "description": "description" + }, + "securityCategories": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "securityCategories" + }, + "dataSetId": { + "type": "integer", + "format": "int32", + "description": "dataSetId" + } + } + }, + "description": "items" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + } + } + } + }, + "post": { + "summary": "Create time series", + "description": "Creates one or more time series.", + "operationId": "CreateTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + }, + "name": { + "type": "string", + "maxLength": 255, + "description": "name" + }, + "isString": { + "type": "boolean", + "description": "isString", + "default": false + }, + "metadata": { + "type": "object", + "description": "metadata" + }, + "unit": { + "type": "string", + "maxLength": 32, + "description": "unit" + }, + "assetId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "assetId" + }, + "isStep": { + "type": "boolean", + "description": "isStep", + "default": false + }, + "description": { + "type": "string", + "maxLength": 1000, + "description": "description" + }, + "securityCategories": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "description": "securityCategories" + }, + "dataSetId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "dataSetId" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "externalId": "pariatur nostrud", + "name": "proident sunt", + "legacyName": "id Excepteur ipsum aliquip", + "isString": false, + "metadata": { + "utfa": "ad", + "reprehenderitf4": "culpa minim ut nostrud" + }, + "unit": "veniam culpa la", + "assetId": 1409981338533354, + "isStep": false, + "description": "in quis", + "securityCategories": [ + -9938878, + 77238587 + ], + "dataSetId": 176441305100480 + } + ] + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "name": { + "type": "string", + "description": "name" + }, + "metadata": { + "type": "object", + "properties": { + "cupidatat4b_": { + "type": "string", + "description": "cupidatat4b_" + }, + "reprehenderit36": { + "type": "string", + "description": "reprehenderit36" + } + }, + "description": "metadata" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "assetId": { + "type": "integer", + "format": "int32", + "description": "assetId" + }, + "description": { + "type": "string", + "description": "description" + }, + "securityCategories": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "securityCategories" + }, + "dataSetId": { + "type": "integer", + "format": "int32", + "description": "dataSetId" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missingFields": { + "type": "array", + "items": {}, + "description": "missingFields" + } + } + } + }, + "409": { + "description": "409", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "externalId": { + "type": "string", + "description": "externalId" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + }, + "422": { + "description": "422", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/byids": { + "post": { + "summary": "Retrieve time series", + "description": "Retrieves one or more time series by ID or external ID. The response returns the time series in the same order as in the request.", + "operationId": "RetrieveTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "items" + }, + "ignoreUnknownIds": { + "type": "boolean", + "description": "ignoreUnknownIds", + "default": false + } + }, + "default": { + "items": [ + { + "id": 6480595772488346 + } + ], + "ignoreUnknownIds": false + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "name": { + "type": "string", + "description": "name" + }, + "metadata": { + "type": "object", + "properties": { + "cupidatat4b_": { + "type": "string", + "description": "cupidatat4b_" + }, + "reprehenderit36": { + "type": "string", + "description": "reprehenderit36" + } + }, + "description": "metadata" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "assetId": { + "type": "integer", + "format": "int32", + "description": "assetId" + }, + "description": { + "type": "string", + "description": "description" + }, + "securityCategories": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "securityCategories" + }, + "dataSetId": { + "type": "integer", + "format": "int32", + "description": "dataSetId" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "missing" + } + }, + "description": "error" + } + } + } + }, + "422": { + "description": "422", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/list": { + "post": { + "summary": "Filter time series", + "description": "
\n\nRetrieves a list of time series that match the given criteria.\n\n\n### Advanced filtering\n\nThe `advancedFilter`\nfield lets you create complex filtering expressions that combine simple operations,\nsuch as `equals`, `prefix`, and `exists`, by using the Boolean operators `and`, `or`, and `not`.\nFiltering applies to basic fields as well as metadata. See the `advancedFilter` syntax in the request example.\n\n\n\n#### Supported leaf filters\n\n| Leaf filter | Supported fields | Description and example |\n|----------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `containsAll` | Array type fields | Only includes results which contain all of the specified values.
`{\"containsAll\": {\"property\": [\"property\"], \"values\": [1, 2, 3]}}` |\n| `containsAny` | Array type fields | Only includes results which contain at least one of the specified values.
`{\"containsAny\": {\"property\": [\"property\"], \"values\": [1, 2, 3]}}` |\n| `equals` | Non-array type fields | Only includes results that are equal to the specified value.
`{\"equals\": {\"property\": [\"property\"], \"value\": \"example\"}}` |\n| `exists` | All fields | Only includes results where the specified property exists (has a value).
`{\"exists\": {\"property\": [\"property\"]}}` |\n| `in` | Non-array type fields | Only includes results that are equal to one of the specified values.
`{\"in\": {\"property\": [\"property\"], \"values\": [1, 2, 3]}}` |\n| `prefix` | String type fields | Only includes results which start with the specified text.
`{\"prefix\": {\"property\": [\"property\"], \"value\": \"example\"}}` |\n| `range` | Non-array type fields | Only includes results that fall within the specified range.
`{\"range\": {\"property\": [\"property\"], \"gt\": 1, \"lte\": 5}}`
Supported operators: `gt`, `lt`, `gte`, `lte` |\n | `search` | `[\"name\"]` and `[\"description\"]` | Introduced to provide functional parity with the /timeseries/search endpoint.
`{\"search\": {\"property\": [\"property\"], \"value\": \"example\"}}` |\n\n#### Supported properties\n\n| Property | Type |\n|-----------------------------------|--------------------|\n| `[\"description\"]` | string |\n| `[\"externalId\"]` | string |\n| `[\"metadata\", \"\"]` | string |\n| `[\"name\"]` | string |\n| `[\"unit\"]` | string |\n| `[\"assetId\"]` | number |\n| `[\"assetRootId\"]` | number |\n| `[\"createdTime\"]` | number |\n| `[\"dataSetId\"]` | number |\n| `[\"id\"]` | number |\n| `[\"lastUpdatedTime\"]` | number |\n| `[\"isStep\"]` | Boolean |\n| `[\"isString\"]` | Boolean |\n| `[\"accessCategories\"]` | array of strings |\n| `[\"securityCategories\"]` | array of numbers |\n\n#### Limits\n\n- Filter query max depth: 10.\n- Filter query max number of clauses: 100.\n- `and` and `or` clauses must have at least one element (and at most 99, since each element counts\n towards the total clause limit, and so does the `and`/`or` clause itself).\n- The `property` array of each leaf filter has the following limitations:\n - Number of elements in the array is 1 or 2.\n - Elements must not be null or blank.\n - Each element max length is 256 characters.\n - The `property` array must match one of the existing properties (static top-level property or dynamic metadata property).\n- `containsAll`, `containsAny`, and `in` filter `values` array size must be in the range [1, 100].\n- `containsAll`, `containsAny`, and `in` filter `values` array must contain elements of number or string type (matching the type of the given property).\n- `range` filter must have at lest one of `gt`, `gte`, `lt`, `lte` attributes.\n But `gt` is mutually exclusive to `gte`, while `lt` is mutually exclusive to `lte`.\n- `gt`, `gte`, `lt`, `lte` in the `range` filter must be of number or string type (matching the type of the given property).\n- `search` filter `value` must not be blank, and the length must be in the range [1, 128], and there\n may be at most two `search` filters in the entire filter query.\n- The maximum length of the `value` of a leaf filter that is applied to a string property is 256.\n\n### Sorting\n\nBy default, time series are sorted by their creation time in ascending order.\nSorting by another property or by several other properties can be explicitly requested via the\n`sort` field, which must contain a list\nof one or more sort specifications. Each sort specification indicates the `property` to sort on\nand, optionally, the `order` in which to sort (defaults to `asc`). If multiple sort specifications are\nsupplied, the results are sorted on the first property, and those with the same value for the first\nproperty are sorted on the second property, and so on. \nPartitioning is done independently of sorting; there is no guarantee of sort order between elements from different partitions.\n\n#### Null values\n\nIn case the `nulls` field has the `auto` value, or the field isn't specified, null (missing) values\nare considered bigger than any other values. They are placed last when sorting in the `asc`\norder and first in the `desc` order. Otherwise, missing values are placed according to\nthe `nulls` field (`last` or `first`), and their placement won't depend on the `order`\nfield. Note that the number zero, empty strings, and empty lists are all considered\n_not_ null.\n\n#### Example\n\n```json\n{\n \"sort\": [\n {\n \"property\" : [\"createdTime\"],\n \"order\": \"desc\",\n \"nulls\": \"last\"\n },\n {\n \"property\" : [\"metadata\", \"\"]\n }\n ]\n}\n```\n\n\n#### Properties\n\nYou can sort on the following properties:\n\n| Property |\n|-----------------------------------|\n| `[\"assetId\"]` |\n| `[\"createdTime\"]` |\n| `[\"dataSetId\"]` |\n| `[\"description\"]` |\n| `[\"externalId\"]` |\n| `[\"lastUpdatedTime\"]` |\n| `[\"metadata\", \"\"]` |\n| `[\"name\"]` |\n\n\n#### Limits\n\nThe `sort` array must contain 1 to 2 elements.\n
", + "operationId": "FilterTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "filter name", + "description": "name" + }, + "unit": { + "type": "string", + "title": "filter unit", + "description": "unit" + }, + "isString": { + "type": "boolean", + "title": "filter isString", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "title": "filter isStep", + "description": "isStep" + }, + "metadata": { + "type": "object", + "title": "filter metadata", + "description": "metadata" + }, + "assetIds": { + "type": "array", + "title": "filter assetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "integer", + "format": "int64" + }, + "description": "assetIds" + }, + "assetExternalIds": { + "type": "array", + "title": "filter assetExternalIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "string" + }, + "description": "assetExternalIds" + }, + "rootAssetIds": { + "type": "array", + "title": "filter rootAssetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "integer", + "format": "int64" + }, + "description": "rootAssetIds" + }, + "assetSubtreeIds": { + "type": "array", + "title": "filter assetSubtreeIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "assetSubtreeIds" + }, + "dataSetIds": { + "type": "array", + "title": "filter dataSetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "dataSetIds" + }, + "externalIdPrefix": { + "type": "string", + "title": "filter externalIdPrefix", + "maxLength": 255, + "description": "externalIdPrefix" + }, + "createdTime": { + "type": "object", + "properties": { + "max": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter createdTime max", + "description": "max" + }, + "min": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter createdTime min", + "description": "min" + } + }, + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "object", + "properties": { + "max": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter lastUpdatedTime max", + "description": "max" + }, + "min": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter lastUpdatedTime min", + "description": "min" + } + }, + "description": "lastUpdatedTime" + } + }, + "description": "filter" + }, + "advancedFilter": { + "type": "object", + "description": "advancedFilter" + }, + "limit": { + "type": "integer", + "format": "int32", + "default": 100, + "minimum": 1, + "maximum": 1000, + "description": "limit" + }, + "cursor": { + "type": "string", + "description": "cursor" + }, + "partition": { + "type": "string", + "description": "partition" + }, + "sort": { + "type": "array", + "minItems": 1, + "maxItems": 2, + "items": { + "type": "object", + "properties": { + "property": { + "type": "array", + "minItems": 1, + "maxItems": 2, + "items": { + "type": "string" + }, + "description": "property" + }, + "order": { + "type": "string", + "description": "order", + "enum": [ + "asc", + "desc" + ] + }, + "nulls": { + "type": "string", + "description": "nulls", + "default": "auto", + "enum": [ + "first", + "last", + "auto" + ] + } + } + }, + "description": "sort" + } + }, + "default": { + "filter": { + "name": "consequat sunt magna in", + "unit": "dolor incididunt aute ", + "isString": false, + "isStep": true, + "metadata": { + "adipisicing_5": "esse sint fugiat Lorem", + "consequat_1": "enim Duis" + }, + "assetIds": [ + 363848954441724, + 793045462540095, + 1261042166839739 + ], + "assetExternalIds": [ + "my.known.id" + ], + "rootAssetIds": [ + 343099548723932, + 88483999203217 + ], + "assetSubtreeIds": [ + { + "id": 4211006077124470 + } + ], + "dataSetIds": [ + { + "id": 6354138669857534 + } + ], + "externalIdPrefix": "my.known.prefix", + "createdTime": { + "max": 62632439, + "min": 6703914 + }, + "lastUpdatedTime": { + "max": 89135725, + "min": 9586224 + } + }, + "advancedFilter": { + "and": [ + { + "value": "" + } + ] + }, + "limit": 100, + "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo", + "partition": "1/10", + "sort": [ + { + "property": [ + "ut commodo ut qui" + ], + "order": "desc", + "nulls": "auto" + } + ] + } + }, + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "name": { + "type": "string", + "description": "name" + }, + "metadata": { + "type": "object", + "properties": { + "tempord": { + "type": "string", + "description": "tempord" + }, + "eiusmod_0_3": { + "type": "string", + "description": "eiusmod_0_3" + }, + "auteb": { + "type": "string", + "description": "auteb" + } + }, + "description": "metadata" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "assetId": { + "type": "integer", + "format": "int32", + "description": "assetId" + }, + "description": { + "type": "string", + "description": "description" + }, + "securityCategories": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "securityCategories" + }, + "dataSetId": { + "type": "integer", + "format": "int32", + "description": "dataSetId" + } + } + }, + "description": "items" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/aggregate": { + "post": { + "summary": "Aggregate time series", + "description": "The aggregation API allows you to compute aggregated results from a set of time series, such as\r\ngetting the number of time series in a project or checking what assets the different time series\r\nin your project are associated with (along with the number of time series for each asset).\r\nBy specifying `filter` and/or `advancedFilter`, the aggregation will take place only over those\r\ntime series that match the filters. `filter` and `advancedFilter` behave the same way as in the\r\n`list` endpoint.\r\n\r\n
\r\n\r\nThe default behavior, when the aggregate field is not specified the request body, is to return the\r\nnumber of time series that match the filters (if any), which is the same behavior as when the\r\naggregate field is set to count.\r\n\r\n\r\nThe following requests will both return the total number of\r\ntime series whose `name` begins with `pump`:\r\n\r\n```\r\n{\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}}\r\n}\r\n```\r\n\r\nand\r\n\r\n```\r\n{\r\n \"aggregate\": \"count\",\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}}\r\n}\r\n```\r\n\r\nThe response might be:\r\n\r\n```\r\n{\"items\": [{\"count\": 42}]}\r\n```\r\n
\r\n\r\n
\r\n\r\nSetting aggregate to uniqueValues and specifying a property in properties (this field is an array, but currently only supports one property) will\r\nreturn all unique values (up to a maximum of 1000) that are taken on by that property\r\nacross all the time series that match the filters, as well as the number of time series that\r\nhave each of those property values.\r\n\r\n\r\nThis example request finds all the unique asset ids that are\r\nreferenced by the time series in your project whose `name` begins with `pump`:\r\n\r\n```\r\n{\r\n \"aggregate\": \"uniqueValues\",\r\n \"properties\": [{\"property\": [\"assetId\"]}],\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}}\r\n}\r\n```\r\n\r\nThe response might be the following, saying that 23 time series are associated with asset 18\r\nand 107 time series are associated with asset 76:\r\n\r\n```\r\n{\r\n \"items\": [\r\n {\"values\": [\"18\"], \"count\": 23},\r\n {\"values\": [\"76\"], \"count\": 107}\r\n ]\r\n}\r\n```\r\n
\r\n\r\n
\r\n\r\nSetting aggregate to cardinalityValues will instead return the approximate number of\r\ndistinct values that are taken on by the given property among the matching time series.\r\n\r\n\r\nExample request:\r\n\r\n```\r\n{\r\n \"aggregate\": \"cardinalityValues\",\r\n \"properties\": [{\"property\": [\"assetId\"]}],\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}}\r\n}\r\n```\r\n\r\nThe result is likely exact when the set of unique values is small. In this example, there are likely two distinct asset ids among the matching time series:\r\n\r\n```\r\n{\"items\": [{\"count\": 2}]}\r\n```\r\n
\r\n\r\n
\r\n\r\nSetting aggregate to uniqueProperties will return the set of unique properties whose property\r\npath begins with path (which can currently only be [\"metadata\"]) that are contained in the time series that match the filters.\r\n\r\n\r\nExample request:\r\n\r\n```\r\n{\r\n \"aggregate\": \"uniqueProperties\",\r\n \"path\": [\"metadata\"],\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}}\r\n}\r\n```\r\n\r\nThe result contains all the unique metadata keys in the time series whose `name` begins with\r\n`pump`, and the number of time series that contains each metadata key:\r\n\r\n```\r\n{\r\n \"items\": [\r\n {\"values\": [{\"property\": [\"metadata\", \"tag\"]}], \"count\": 43},\r\n {\"values\": [{\"property\": [\"metadata\", \"installationDate\"]}], \"count\": 97}\r\n ]\r\n}\r\n```\r\n
\r\n\r\n
\r\n\r\nSetting aggregate to cardinalityProperties will instead return the approximate number of\r\ndifferent property keys whose path begins with path (which can currently only be [\"metadata\"], meaning that this can only be used to count the approximate number of distinct metadata keys among the matching time series).\r\n\r\n\r\nExample request:\r\n\r\n```\r\n{\r\n \"aggregate\": \"cardinalityProperties\",\r\n \"path\": [\"metadata\"],\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}}\r\n}\r\n```\r\n\r\nThe result is likely exact when the set of unique values is small. In this example, there are likely two distinct metadata keys among the matching time series:\r\n\r\n```\r\n{\"items\": [{\"count\": 2}]}\r\n```\r\n
\r\n\r\nThe `aggregateFilter` field may be specified if `aggregate` is set to `cardinalityProperties` or `uniqueProperties`. The structure of this field is similar to that of `advancedFilter`, except that the set of leaf filters is smaller (`in`, `prefix`, and `range`), and that none of the leaf filters specify a property. Unlike `advancedFilter`, which is applied _before_ the aggregation (in order to restrict the set of time series that the aggregation operation should be applied to), `aggregateFilter` is applied _after_ the initial aggregation has been performed, in order to restrict the set of results.\r\n\r\n
\r\n\r\nClick here for more details about aggregateFilter. \r\n\r\n\r\nWhen `aggregate` is set to `uniqueProperties`, the result set contains a number of _property paths_, each with an associated count that shows how many time series contained that property (among those time series that matched the `filter` and `advancedFilter`, if they were specified) . If `aggregateFilter` is specified, it will restrict the property paths included in the output. Let us add an `aggregateFilter` to the `uniqueProperties` example from above:\r\n\r\n```\r\n{\r\n \"aggregate\": \"uniqueProperties\",\r\n \"path\": [\"metadata\"],\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}},\r\n \"aggregateFilter\": {\"prefix\": {\"value\": \"t\"}}\r\n}\r\n```\r\n\r\nNow, the result only contains those metadata properties whose key begins with `t` (but it will be the same set of metadata properties that begin with `t` as in the original query without `aggregateFilter`, and the counts will be the same):\r\n\r\n```\r\n{\r\n \"items\": [\r\n {\"values\": [{\"property\": [\"metadata\", \"tag\"]}], \"count\": 43}\r\n ]\r\n}\r\n```\r\n\r\nSimilarly, adding `aggregateFilter` to `cardinalityProperties` will return the approximate number of properties whose property key matches `aggregateFilter` from those time series matching the `filter` and `advancedFilter` (or from all time series if neither `filter` nor `aggregateFilter` are specified):\r\n\r\n```\r\n{\r\n \"aggregate\": \"cardinalityProperties\",\r\n \"path\": [\"metadata\"],\r\n \"advancedFilter\": {\"prefix\": {\"property\": [\"name\"], \"value\": \"pump\"}},\r\n \"aggregateFilter\": {\"prefix\": {\"value\": \"t\"}}\r\n}\r\n```\r\n\r\nAs we saw above, only one property matches:\r\n\r\n```\r\n{\"items\": [{\"count\": 1}]}\r\n```\r\n\r\nNote that `aggregateFilter` is also accepted when `aggregate` is set to `cardinalityValues` or `cardinalityProperties`. For those aggregations, the effect of any `aggregateFilter` could also be achieved via a similar `advancedFilter`. However, `aggregateFilter` is not accepted when `aggregate` is omitted or set to `count`.\r\n
\r\n\r\n### Rate and concurrency limits\r\n\r\nRate and concurrency limits apply this endpoint. If a request exceeds one of the limits,\r\nit will be throttled with a `429: Too Many Requests` response. More on limit types\r\nand how to avoid being throttled is described\r\n[here](https://developer.cognite.com/dev/concepts/request_throttling/).\r\n\r\n| Limit | Per project | Per user (identity) |\r\n|----------------|-----------------------|-----------------------|\r\n| Rate | 15 requests per second| 10 requests per second|\r\n| Concurrency | 6 concurrent requests | 4 concurrent requests |\r\n", + "operationId": "AggregateTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "advancedFilter": { + "type": "object", + "description": "advancedFilter" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "filter name", + "description": "name" + }, + "unit": { + "type": "string", + "title": "filter unit", + "description": "unit" + }, + "isString": { + "type": "boolean", + "title": "filter isString", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "title": "filter isStep", + "description": "isStep" + }, + "metadata": { + "type": "object", + "title": "filter metadata", + "description": "metadata" + }, + "assetIds": { + "type": "array", + "title": "filter assetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "integer", + "format": "int64" + }, + "description": "assetIds" + }, + "assetExternalIds": { + "type": "array", + "title": "filter assetExternalIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "string" + }, + "description": "assetExternalIds" + }, + "rootAssetIds": { + "type": "array", + "title": "filter rootAssetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "integer", + "format": "int64" + }, + "description": "rootAssetIds" + }, + "assetSubtreeIds": { + "type": "array", + "title": "filter assetSubtreeIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "assetSubtreeIds" + }, + "dataSetIds": { + "type": "array", + "title": "filter dataSetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "dataSetIds" + }, + "externalIdPrefix": { + "type": "string", + "title": "filter externalIdPrefix", + "maxLength": 255, + "description": "externalIdPrefix" + }, + "createdTime": { + "type": "object", + "properties": { + "max": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter createdTime max", + "description": "max" + }, + "min": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter createdTime min", + "description": "min" + } + }, + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "object", + "properties": { + "max": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter lastUpdatedTime max", + "description": "max" + }, + "min": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter lastUpdatedTime min", + "description": "min" + } + }, + "description": "lastUpdatedTime" + } + }, + "description": "filter" + }, + "aggregateFilter": { + "type": "object", + "description": "aggregateFilter" + }, + "aggregate": { + "type": "string", + "description": "aggregate" + }, + "properties": { + "type": "object", + "description": "properties" + }, + "path": { + "type": "array", + "minItems": 1, + "maxItems": 1, + "items": { + "type": "string", + "enum": [ + "metadata" + ] + }, + "description": "path" + } + }, + "default": { + "advancedFilter": { + "and": [ + { + "value": "" + } + ] + }, + "filter": { + "name": "cillum u", + "unit": "minim nisi veniam consequat ad", + "isString": false, + "isStep": false, + "metadata": { + "veniamab": "ut ex", + "mollit3": "culpa tempor laborum est in" + }, + "assetIds": [ + 363848954441724, + 793045462540095, + 1261042166839739 + ], + "assetExternalIds": [ + "my.known.id" + ], + "rootAssetIds": [ + 343099548723932, + 88483999203217 + ], + "assetSubtreeIds": [ + { + "id": 2811826996920158 + } + ], + "dataSetIds": [ + { + "id": 8377002788951225 + } + ], + "externalIdPrefix": "my.known.prefix", + "createdTime": { + "max": 46278706, + "min": 7716985 + }, + "lastUpdatedTime": { + "max": 41603320, + "min": 3384231 + } + }, + "aggregateFilter": { + "and": [ + { + "value": "" + } + ] + }, + "aggregate": "count" + } + }, + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "count" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/search": { + "post": { + "summary": "Search time series", + "description": "Fulltext search for time series based on result relevance. Primarily meant\nfor human-centric use cases, not for programs, since matching and\norder may change over time. Additional filters can also be\nspecified. This operation does not support pagination.", + "operationId": "SearchTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "filter name", + "description": "name" + }, + "unit": { + "type": "string", + "title": "filter unit", + "description": "unit" + }, + "isString": { + "type": "boolean", + "title": "filter isString", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "title": "filter isStep", + "description": "isStep" + }, + "metadata": { + "type": "object", + "title": "filter metadata", + "description": "metadata" + }, + "assetIds": { + "type": "array", + "title": "filter assetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "integer", + "format": "int64" + }, + "description": "assetIds" + }, + "assetExternalIds": { + "type": "array", + "title": "filter assetExternalIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "string" + }, + "description": "assetExternalIds" + }, + "rootAssetIds": { + "type": "array", + "title": "filter rootAssetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "integer", + "format": "int64" + }, + "description": "rootAssetIds" + }, + "assetSubtreeIds": { + "type": "array", + "title": "filter assetSubtreeIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "assetSubtreeIds" + }, + "dataSetIds": { + "type": "array", + "title": "filter dataSetIds", + "minItems": 1, + "maxItems": 100, + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "dataSetIds" + }, + "externalIdPrefix": { + "type": "string", + "title": "filter externalIdPrefix", + "maxLength": 255, + "description": "externalIdPrefix" + }, + "createdTime": { + "type": "object", + "properties": { + "max": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter createdTime max", + "description": "max" + }, + "min": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter createdTime min", + "description": "min" + } + }, + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "object", + "properties": { + "max": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter lastUpdatedTime max", + "description": "max" + }, + "min": { + "type": "integer", + "format": "int64", + "minimum": 0, + "title": "filter lastUpdatedTime min", + "description": "min" + } + }, + "description": "lastUpdatedTime" + } + }, + "description": "filter" + }, + "search": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "search name", + "description": "name" + }, + "description": { + "type": "string", + "title": "search description", + "description": "description" + }, + "query": { + "type": "string", + "title": "search query", + "description": "query" + } + }, + "description": "search" + }, + "limit": { + "type": "integer", + "format": "int32", + "default": 100, + "minimum": 1, + "maximum": 1000, + "description": "limit" + } + }, + "default": { + "filter": { + "name": "dolore Duis reprehenderit in velit", + "unit": "reprehenderit velit", + "isString": false, + "isStep": false, + "metadata": { + "nisi_c": "ipsum" + }, + "assetIds": [ + 363848954441724, + 793045462540095, + 1261042166839739 + ], + "assetExternalIds": [ + "my.known.id" + ], + "rootAssetIds": [ + 343099548723932, + 88483999203217 + ], + "assetSubtreeIds": [ + { + "id": 5739678374793478 + } + ], + "dataSetIds": [ + { + "id": 1013419334254488 + } + ], + "externalIdPrefix": "my.known.prefix", + "createdTime": { + "max": 23053915, + "min": 16855291 + }, + "lastUpdatedTime": { + "max": 35295875, + "min": 48926022 + } + }, + "search": { + "name": "non in minim fugiat ma", + "description": "dolor veniam in", + "query": "some other" + }, + "limit": 100 + } + }, + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "name": { + "type": "string", + "description": "name" + }, + "metadata": { + "type": "object", + "properties": { + "cupidatat4b_": { + "type": "string", + "description": "cupidatat4b_" + }, + "reprehenderit36": { + "type": "string", + "description": "reprehenderit36" + } + }, + "description": "metadata" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "assetId": { + "type": "integer", + "format": "int32", + "description": "assetId" + }, + "description": { + "type": "string", + "description": "description" + }, + "securityCategories": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "securityCategories" + }, + "dataSetId": { + "type": "integer", + "format": "int32", + "description": "dataSetId" + } + } + }, + "description": "items" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/update": { + "post": { + "summary": "Update time series", + "description": "Updates one or more time series. Fields outside of the request remain unchanged.\n\nFor primitive fields (those whose type is string, number, or boolean), use `\"set\": value`\nto update the value; use `\"setNull\": true` to set the field to null.\n\nFor JSON array fields (for example `securityCategories`), use `\"set\": [value1, value2]` to\nupdate the value; use `\"add\": [value1, value2]` to add values; use\n`\"remove\": [value1, value2]` to remove values.", + "operationId": "UpdateTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + }, + "update": { + "type": "object", + "properties": { + "externalId": { + "type": "object", + "title": "update externalId", + "description": "externalId" + }, + "name": { + "type": "object", + "title": "update name", + "description": "name" + }, + "metadata": { + "type": "object", + "title": "update metadata", + "description": "metadata" + }, + "unit": { + "type": "object", + "title": "update unit", + "description": "unit" + }, + "assetId": { + "type": "object", + "title": "update assetId", + "description": "assetId" + }, + "isStep": { + "type": "object", + "title": "update isStep", + "description": "isStep" + }, + "description": { + "type": "object", + "title": "update description", + "description": "description" + }, + "securityCategories": { + "type": "object", + "title": "update securityCategories", + "description": "securityCategories" + }, + "dataSetId": { + "type": "object", + "title": "update dataSetId", + "description": "dataSetId" + } + }, + "description": "update" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "id": 65578963223840, + "update": { + "externalId": { + "set": "deser" + }, + "name": { + "set": "quis do fugiat" + }, + "metadata": { + "set": { + "key1": "value1", + "key2": "value2" + } + }, + "unit": { + "set": "occaecat e" + }, + "assetId": { + "set": -49293797 + }, + "isStep": { + "set": false + }, + "description": { + "set": "eu officia Lorem in" + }, + "securityCategories": { + "set": [ + 43965436, + -26623388 + ] + }, + "dataSetId": { + "set": -82503202 + } + } + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "name": { + "type": "string", + "description": "name" + }, + "metadata": { + "type": "object", + "properties": { + "cupidatat4b_": { + "type": "string", + "description": "cupidatat4b_" + }, + "reprehenderit36": { + "type": "string", + "description": "reprehenderit36" + } + }, + "description": "metadata" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "assetId": { + "type": "integer", + "format": "int32", + "description": "assetId" + }, + "description": { + "type": "string", + "description": "description" + }, + "securityCategories": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "securityCategories" + }, + "dataSetId": { + "type": "integer", + "format": "int32", + "description": "dataSetId" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "missing" + } + }, + "description": "error" + } + } + } + }, + "409": { + "description": "409", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "externalId": { + "type": "string", + "description": "externalId" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + }, + "422": { + "description": "422", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/delete": { + "post": { + "summary": "Delete time series", + "description": "Deletes the time series with the specified IDs and their data points.", + "operationId": "DeleteTimeSeries", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "minItems": 1, + "maxItems": 1000, + "uniqueItems": true, + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "items" + }, + "ignoreUnknownIds": { + "type": "boolean", + "default": false, + "description": "ignoreUnknownIds" + } + }, + "default": { + "items": [ + { + "id": 6480595772488346 + } + ], + "ignoreUnknownIds": false + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": {} + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "missing" + } + }, + "description": "error" + } + } + } + }, + "422": { + "description": "422", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/data": { + "post": { + "summary": "Insert data points", + "description": "Insert data points into a time series. You can do this for multiple time series.\nIf you insert a data point with a timestamp that already exists, it will be overwritten with the new value.", + "operationId": "InsertDataPoints", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "minItems": 1, + "maxItems": 10000, + "properties": { + "datapoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "integer", + "format": "int64", + "minimum": -2208988800000, + "maximum": 4102444799999, + "description": "timestamp" + }, + "value": { + "type": "number", + "format": "float", + "description": "value" + } + } + }, + "description": "datapoints" + }, + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "datapoints": [ + { + "timestamp": 608494106366, + "value": -56402208.93382395 + }, + { + "timestamp": 608494106366, + "value": -56402208.93382395 + } + ], + "id": 6823593518033699 + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": {} + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "missing" + } + }, + "description": "error" + } + } + } + }, + "422": { + "description": "422", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/data/list": { + "post": { + "summary": "Retrieve data points", + "description": "Retrieves a list of data points from multiple time series in a project.\nThis operation supports aggregation and pagination.\nLearn more about [aggregation]().\n\nNote: when `start` isn't specified in the top level and for an individual item, it will default to epoch 0, which is 1 January, 1970, thus\nexcluding potential existent data points before 1970. `start` needs to be specified as a negative number to get data points before 1970.", + "operationId": "RetrieveDataPoints", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + }, + "start": { + "description": "start" + }, + "end": { + "description": "end" + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "limit" + }, + "aggregates": { + "type": "array", + "minItems": 1, + "maxItems": 10, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "average", + "max", + "min", + "count", + "sum", + "interpolation", + "stepInterpolation", + "totalVariation", + "continuousVariance", + "discreteVariance" + ] + }, + "description": "aggregates" + }, + "granularity": { + "type": "string", + "description": "granularity" + }, + "includeOutsidePoints": { + "type": "boolean", + "default": false, + "description": "includeOutsidePoints" + }, + "cursor": { + "type": "string", + "description": "cursor" + } + } + }, + "description": "items" + }, + "start": { + "description": "start" + }, + "end": { + "description": "end" + }, + "limit": { + "type": "integer", + "format": "int32", + "default": 100, + "description": "limit" + }, + "aggregates": { + "type": "array", + "minItems": 1, + "maxItems": 10, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "average", + "max", + "min", + "count", + "sum", + "interpolation", + "stepInterpolation", + "totalVariation", + "continuousVariance", + "discreteVariance" + ] + }, + "description": "aggregates" + }, + "granularity": { + "type": "string", + "description": "granularity" + }, + "includeOutsidePoints": { + "type": "boolean", + "default": false, + "description": "includeOutsidePoints" + }, + "ignoreUnknownIds": { + "type": "boolean", + "default": false, + "description": "ignoreUnknownIds" + } + }, + "default": { + "items": [ + { + "id": 93079970617258, + "start": 0, + "end": -79469719, + "limit": 40593951, + "aggregates": [ + "average" + ], + "granularity": "1h", + "includeOutsidePoints": false, + "cursor": "dolor" + } + ], + "start": 0, + "end": -42314496, + "limit": 100, + "aggregates": [ + "totalVariation" + ], + "granularity": "1h", + "includeOutsidePoints": false, + "ignoreUnknownIds": false + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "datapoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "integer", + "format": "int32", + "description": "timestamp" + }, + "average": { + "type": "number", + "format": "float", + "description": "average" + }, + "max": { + "type": "number", + "format": "float", + "description": "max" + }, + "min": { + "type": "number", + "format": "float", + "description": "min" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "count" + }, + "sum": { + "type": "number", + "format": "float", + "description": "sum" + }, + "interpolation": { + "type": "number", + "format": "float", + "description": "interpolation" + }, + "stepInterpolation": { + "type": "number", + "format": "float", + "description": "stepInterpolation" + }, + "continuousVariance": { + "type": "number", + "format": "float", + "description": "continuousVariance" + }, + "discreteVariance": { + "type": "number", + "format": "float", + "description": "discreteVariance" + }, + "totalVariation": { + "type": "number", + "format": "float", + "description": "totalVariation" + } + } + }, + "description": "datapoints" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "missing" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/data/latest": { + "post": { + "summary": "Retrieve latest data point", + "description": "Retrieves the latest data point in one or more time series. Note that the latest data point\nin a time series is the one with the highest timestamp, which is not necessarily the one\nthat was ingested most recently.\n", + "operationId": "RetrieveLatestDataPoint", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + }, + "before": { + "type": "string", + "default": "now", + "description": "before" + } + } + }, + "description": "items" + }, + "ignoreUnknownIds": { + "type": "boolean", + "default": false, + "description": "ignoreUnknownIds" + } + }, + "default": { + "items": [ + { + "id": 7580062250379539, + "before": "now" + } + ], + "ignoreUnknownIds": false + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "datapoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "integer", + "format": "int32", + "description": "timestamp" + }, + "value": { + "type": "number", + "format": "float", + "description": "value" + } + } + }, + "description": "datapoints" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "id" + }, + "isString": { + "type": "boolean", + "description": "isString" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isStep": { + "type": "boolean", + "description": "isStep" + }, + "unit": { + "type": "string", + "description": "unit" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "missing" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/timeseries/data/delete": { + "post": { + "summary": "Delete data points", + "description": "Delete data points from time series.", + "operationId": "DeleteDataPoints", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 10000, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 9007199254740991, + "description": "id" + }, + "externalId": { + "type": "string", + "maxLength": 255, + "description": "externalId" + }, + "inclusiveBegin": { + "type": "integer", + "format": "int64", + "minimum": -2208988800000, + "description": "inclusiveBegin" + }, + "exclusiveEnd": { + "type": "integer", + "format": "int64", + "minimum": -2208988800000, + "description": "exclusiveEnd" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "id": 7670293525694559, + "inclusiveBegin": 1638795554528, + "exclusiveEnd": 1638795554528 + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": {} + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "id" + } + } + }, + "description": "missing" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/spaces": { + "get": { + "summary": "List spaces defined in the project", + "description": "List spaces defined in the current project.", + "operationId": "ListSpacesDefinedInTheProject", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "limit", + "default": 10, + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000, + "required": false + }, + { + "name": "cursor", + "in": "query", + "type": "string", + "required": false + }, + { + "name": "includeGlobal", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "space": { + "type": "string", + "description": "space" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + } + }, + "description": "items" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + }, + "post": { + "summary": "Create or update spaces", + "description": "Add or update (upsert) spaces. For unchanged space specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for spaces that remain unchanged.", + "operationId": "CreateOrUpdateSpaces", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "(?!^(space|cdf|dms|pg3|shared|system|node|edge)$)(^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$)", + "description": "space" + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "description" + }, + "name": { + "type": "string", + "maxLength": 1024, + "description": "name" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "SURsuZ7PE5ZO2ifQ", + "description": "dolore id quis", + "name": "laborum Lorem" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "space": { + "type": "string", + "description": "space" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + }, + "409": { + "description": "409", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/spaces/byids": { + "post": { + "summary": "Retrieve spaces by their space-ids", + "description": "Retrieve up to 100 spaces by specifying their space-ids.", + "operationId": "RetrieveSpacesByTheirSpace-ids", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "Di" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "space": { + "type": "string", + "description": "space" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/spaces/delete": { + "post": { + "summary": "Delete spaces", + "description": "Delete one or more spaces. Currently limited to 100 spaces at a time.\n\n\nIf an existing data model references a space, you cannot delete that space. Nodes, edges and other data types that are part of a space will no longer be available. ", + "operationId": "DeleteSpaces", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "Di" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "description": "space" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/datamodels": { + "get": { + "summary": "List data models defined in the project", + "description": "List data models defined in the project. You can filter the returned models by the specified space.", + "operationId": "ListDataModelsDefinedInTheProject", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "limit", + "default": 10, + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000, + "required": false + }, + { + "name": "cursor", + "in": "query", + "type": "string", + "required": false + }, + { + "name": "inlineViews", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "space", + "in": "query", + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "required": false + }, + { + "name": "allVersions", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "includeGlobal", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "space": { + "type": "string", + "description": "space" + }, + "version": { + "type": "string", + "description": "version" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "views": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "views" + } + } + }, + "description": "items" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + }, + "post": { + "summary": "Create or update data models", + "description": "Add or update (upsert) data models. For unchanged data model specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for models that remain unchanged.", + "operationId": "CreateOrUpdateDataModels", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + }, + "name": { + "type": "string", + "maxLength": 255, + "description": "name" + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "description" + }, + "views": { + "type": "array", + "items": { + "type": "object" + }, + "description": "views" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "NtJY_sMmOoW6X1JGq0YBNR_91Uo5AMoXGipVb", + "externalId": "RZSjBFjX1cE1iwXErZAoB3tVCC_JBrdIBYvMxqgooZJ6QpT9", + "version": "o", + "name": "officia Duis et voluptate est", + "description": "ut irure", + "views": [ + { + "type": "view", + "space": "gO_43wx0nKRbr", + "externalId": "cItsYBRmpgiyfIkopAreCbGtsNoCeOCDLPhCQNtPPk", + "version": "B" + }, + { + "type": "view", + "space": "gO_43wx0nKRbr", + "externalId": "cItsYBRmpgiyfIkopAreCbGtsNoCeOCDLPhCQNtPPk", + "version": "B" + } + ] + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "space": { + "type": "string", + "description": "space" + }, + "version": { + "type": "string", + "description": "version" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "views": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "views" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + }, + "409": { + "description": "409", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/datamodels/byids": { + "post": { + "summary": "Retrieve data models by their external ids", + "description": "Retrieve up to 100 data models by their external ids. Views can be auto-expanded when the ```InlineViews``` query parameter is set.", + "operationId": "RetrieveDataModelsByTheirExternalIds", + "parameters": [ + { + "name": "inlineViews", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "qt45rYd8TMaMn", + "externalId": "m", + "version": "37t" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "space": { + "type": "string", + "description": "space" + }, + "version": { + "type": "string", + "description": "version" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "views": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "views" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/datamodels/delete": { + "post": { + "summary": "Delete data models", + "description": "Delete one or more data models. Currently limited to 100 models at a time. This does not delete the views, nor the containers they reference.", + "operationId": "DeleteDataModels", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "rTjL9", + "externalId": "e4pmfFeWhF5OquUZiIVL2AXgazXZUdvwwPzTiFN7Q1S_Z2wWCsP94xpMtWPziiNxQotEIaue5vvBReTQozKaUUtiVX8p5RcbgwYbdkTFRbBK1qcRHcdwSXlLRRqlVbeCAFGQkKh2nvwGI2OHRodBWFGWx59G4oB82rpaLmbSmdL11bajBKzcOsUDaO0KWth6XxDpjBV4", + "version": "QpE" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/views": { + "get": { + "summary": "List views defined in the project", + "description": "List of views defined in the current project. You can filter the list by specifying a space.", + "operationId": "ListViewsDefinedInTheProject", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "limit", + "default": 10, + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000, + "required": false + }, + { + "name": "cursor", + "in": "query", + "type": "string", + "required": false + }, + { + "name": "space", + "in": "query", + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "required": false + }, + { + "name": "includeInheritedProperties", + "default": true, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "allVersions", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "includeGlobal", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "properties": { + "type": "object", + "properties": { + "Excepteur_6": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "Excepteur_6" + }, + "enim7": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "enim7" + }, + "in_b0": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "in_b0" + } + }, + "description": "properties" + }, + "space": { + "type": "string", + "description": "space" + }, + "usedFor": { + "type": "string", + "description": "usedFor" + }, + "version": { + "type": "string", + "description": "version" + }, + "writable": { + "type": "boolean", + "description": "writable" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "filter": { + "type": "object", + "properties": { + "and": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "value" + } + } + }, + "description": "and" + } + }, + "description": "filter" + }, + "implements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "implements" + } + } + }, + "description": "items" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + }, + "post": { + "summary": "Create or update views", + "description": "Add or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for views that remain unchanged.", + "operationId": "CreateOrUpdateViews", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + }, + "name": { + "type": "string", + "maxLength": 255, + "description": "name" + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "description" + }, + "filter": { + "type": "object", + "description": "filter" + }, + "implements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + } + }, + "description": "implements" + }, + "properties": { + "type": "object", + "description": "properties" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "externalId": "DAku8Bclc8T2X9JMOsxXw99YPQXrI228j3Hh54zxWiKsbC884166KAHtGrEzLPxmNOr3VCisVIy5qLLszhPpA95q7meY0AiBXwem0K_3JpdoNVeDe0tc6N7Mk0WRid83v7v8xBkkrHLTcWcvfSgiVUPAOvLhcGQiJKle17X_B1nx0dCxThmvNgygXNvQRpTNjJ9vbydZRugercZISf_P7QOYXSpy1FC1vYvJs_r0J7looSaIwTsMMklXA_1", + "space": "hzRZsh7zKJec3EVb764w", + "version": "1939Iea9FAnKVqOTUz.4t", + "name": "veniam", + "description": "pariatur enim", + "filter": { + "and": [ + { + "value": "" + } + ] + }, + "implements": [ + { + "type": "view", + "space": "XE6HHCxAsW7lgdqei8AlFUy", + "externalId": "j", + "version": "sBEJgk-xR_XAThVe6sZt92w0lGSwKfpHF3cWIdP" + }, + { + "type": "view", + "space": "XE6HHCxAsW7lgdqei8AlFUy", + "externalId": "j", + "version": "sBEJgk-xR_XAThVe6sZt92w0lGSwKfpHF3cWIdP" + } + ], + "properties": { + "laborum_a": { + "container": { + "type": "container", + "space": "J3ks4m7gD", + "externalId": "f" + }, + "containerPropertyIdentifier": "P", + "name": "Excepteur", + "description": "minim dolore labore cillum", + "source": { + "type": "view", + "space": "CGel", + "externalId": "yrmXkkZR9p1REPX_xZGu7IBMsJDgPEFjX9i36JnNzRxw_z0MGZzDXTXsMOhQhRAFmLb6rwe2wErZhtXvghuWQYrobl3V58n8iksbC8ao_9fyVxpufYEMgCpcpl6vDl0PPkR63jfNHvb", + "version": "AOhIG.SSGth7E8QrvYwSvcj" + } + }, + "pariatur0d": { + "container": { + "type": "container", + "space": "C8kW8rSrkUf3Ynl", + "externalId": "sIX0UulHl" + }, + "containerPropertyIdentifier": "R4WxmHY608yp9X7HuntgtAMaKkUdb7BvN2aRRuCpxVXz1Rccg", + "name": "eiusmod minim consectetur", + "description": "pariatur consequat ex ut", + "source": { + "type": "view", + "space": "hDW", + "externalId": "Vx9evBKhhkWPUARdU_EnNPoKrMPE1z9eSPiDmztUGZdKYRCindKTd6GdInsWi57Xg3hwDOsqhsIpxPuwMdYoXqJZl3YUj431NZZ9VhcopDOKM7rhXccgWABT8EVC1DuEWP2sk3PXhKegCCbJ", + "version": "Z" + } + } + } + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "properties": { + "type": "object", + "properties": { + "ea_603": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "ea_603" + }, + "Excepteurd7": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "Excepteurd7" + }, + "officia_6": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "officia_6" + }, + "nisidb": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "nisidb" + }, + "ut3": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "ut3" + } + }, + "description": "properties" + }, + "space": { + "type": "string", + "description": "space" + }, + "usedFor": { + "type": "string", + "description": "usedFor" + }, + "version": { + "type": "string", + "description": "version" + }, + "writable": { + "type": "boolean", + "description": "writable" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "filter": { + "type": "object", + "properties": { + "and": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "value" + } + } + }, + "description": "and" + } + }, + "description": "filter" + }, + "implements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "implements" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + }, + "409": { + "description": "409", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/views/byids": { + "post": { + "summary": "Retrieve views by their external ids", + "description": "Retrieve up to 100 views by their external ids.", + "operationId": "RetrieveViewsByTheirExternalIds", + "parameters": [ + { + "name": "includeInheritedProperties", + "default": true, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "qt45rYd8TMaMn", + "externalId": "m", + "version": "37t" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "properties": { + "type": "object", + "properties": { + "nostrud_cc1": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "nostrud_cc1" + }, + "ipsum_df": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "ipsum_df" + }, + "eu3": { + "type": "object", + "properties": { + "container": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "container" + }, + "containerPropertyIdentifier": { + "type": "string", + "description": "containerPropertyIdentifier" + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "eu3" + } + }, + "description": "properties" + }, + "space": { + "type": "string", + "description": "space" + }, + "usedFor": { + "type": "string", + "description": "usedFor" + }, + "version": { + "type": "string", + "description": "version" + }, + "writable": { + "type": "boolean", + "description": "writable" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "filter": { + "type": "object", + "properties": { + "and": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "value" + } + } + }, + "description": "and" + } + }, + "description": "filter" + }, + "implements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "implements" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/views/delete": { + "post": { + "summary": "Delete views", + "description": "Delete one or more views. Currently limited to 100 views at a time. The service cannot delete a view referenced by a data model.", + "operationId": "DeleteViews", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "rTjL9", + "externalId": "e4pmfFeWhF5OquUZiIVL2AXgazXZUdvwwPzTiFN7Q1S_Z2wWCsP94xpMtWPziiNxQotEIaue5vvBReTQozKaUUtiVX8p5RcbgwYbdkTFRbBK1qcRHcdwSXlLRRqlVbeCAFGQkKh2nvwGI2OHRodBWFGWx59G4oB82rpaLmbSmdL11bajBKzcOsUDaO0KWth6XxDpjBV4", + "version": "QpE" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "version": { + "type": "string", + "description": "version" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/containers": { + "get": { + "summary": "List containers defined in the project", + "description": "List of containers defined in the current project. You can filter the list by specifying a space.", + "operationId": "ListContainersDefinedInTheProject", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "limit", + "default": 10, + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000, + "required": false + }, + { + "name": "cursor", + "in": "query", + "type": "string", + "required": false + }, + { + "name": "space", + "in": "query", + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "required": false + }, + { + "name": "includeGlobal", + "default": false, + "in": "query", + "type": "boolean", + "required": false + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "properties": { + "type": "object", + "properties": { + "amet__": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "amet__" + }, + "deserunt56": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "deserunt56" + }, + "ind19": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "ind19" + }, + "sedf": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "sedf" + } + }, + "description": "properties" + }, + "space": { + "type": "string", + "description": "space" + }, + "usedFor": { + "type": "string", + "description": "usedFor" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "constraints": { + "type": "object", + "properties": { + "reprehenderite": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "reprehenderite" + }, + "proident87": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "proident87" + }, + "occaecat5": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "occaecat5" + }, + "aliquip__b7": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "aliquip__b7" + } + }, + "description": "constraints" + }, + "indexes": { + "type": "object", + "properties": { + "elit59_": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "elit59_" + }, + "laborum_e8": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "laborum_e8" + }, + "ut_8bc": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "ut_8bc" + }, + "laborum_4_0": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "laborum_4_0" + } + }, + "description": "indexes" + } + } + }, + "description": "items" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + }, + "post": { + "summary": "Create or update containers", + "description": "Add or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for containers that remain unchanged.", + "operationId": "CreateOrUpdateContainers", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "properties": { + "type": "object", + "description": "properties" + }, + "name": { + "type": "string", + "maxLength": 255, + "description": "name" + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "description" + }, + "usedFor": { + "type": "string", + "default": "node", + "enum": [ + "node", + "edge", + "all" + ], + "description": "usedFor" + }, + "constraints": { + "type": "object", + "description": "constraints" + }, + "indexes": { + "type": "object", + "description": "indexes" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "jp7QwmJ0KOtb8FpAeF9A", + "externalId": "dgPrNshe0ZMssmbwvkGJDoWl4ObFLd62OITAzBEuT0_Ar1dQmLsYvLv5i84TpSDBJwliHIOrBgoLHuZgEkql8q4Oa7wrMZn6OQlc06regmfs2Z89RJxsU2Z8HUXqrZQ7beAhPPyJhyo5FEcXTGT8LScq1sMh43gsQ6sBJyy6Z0mYFcg4CV", + "properties": { + "pariatur_e30": { + "type": { + "type": "text", + "list": false, + "collation": "ucs_basic" + }, + "nullable": true, + "autoIncrement": false, + "defaultValue": "tempor elit eiusmod", + "description": "aliqua eu ", + "name": "veniam" + }, + "sit_11": { + "type": { + "type": "text", + "list": false, + "collation": "ucs_basic" + }, + "nullable": true, + "autoIncrement": false, + "defaultValue": "et deserunt", + "description": "culpa cillum proident Lorem ex", + "name": "reprehenderit sint" + }, + "Lorem_6": { + "type": { + "type": "text", + "list": false, + "collation": "ucs_basic" + }, + "nullable": true, + "autoIncrement": false, + "defaultValue": "aliquip laboris", + "description": "mollit fugiat", + "name": "amet" + } + }, + "name": "veniam cupidatat culpa consectetur dolor", + "description": "aliquip cillum consequat voluptate tempor", + "usedFor": "node", + "constraints": { + "adipisicing_189": { + "require": { + "type": "container", + "space": "q", + "externalId": "SWCWubSiruLDPvQpxfDaM_rgD" + }, + "constraintType": "requires" + }, + "nulla_4e": { + "require": { + "type": "container", + "space": "d3StFH01lM-aQSBlSSWooKbu8R_VHG_vDs0F", + "externalId": "D7NAXYatZiphC" + }, + "constraintType": "requires" + } + }, + "indexes": { + "aliquaf02": { + "properties": [ + "pariatur dolore enim ", + "cillum aute sunt nulla in" + ], + "indexType": "btree", + "cursorable": false + } + } + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "properties": { + "type": "object", + "properties": { + "exercitation_98": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "exercitation_98" + }, + "do2": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "do2" + }, + "ad_8": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "ad_8" + }, + "eiusmod4c5": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "eiusmod4c5" + } + }, + "description": "properties" + }, + "space": { + "type": "string", + "description": "space" + }, + "usedFor": { + "type": "string", + "description": "usedFor" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "constraints": { + "type": "object", + "properties": { + "adipisicingf92": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "adipisicingf92" + }, + "laborum_a": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "laborum_a" + }, + "adcb": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "adcb" + } + }, + "description": "constraints" + }, + "indexes": { + "type": "object", + "properties": { + "aliqua_c": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "aliqua_c" + }, + "ut_d": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "ut_d" + }, + "elit13f": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "elit13f" + }, + "voluptate_903": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "voluptate_903" + }, + "magna_b9": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "magna_b9" + } + }, + "description": "indexes" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + }, + "409": { + "description": "409", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/containers/byids": { + "post": { + "summary": "Retrieve containers by their external ids", + "description": "Retrieve up to 100 containers by their specified external ids.", + "operationId": "RetrieveContainersByTheirExternalIds", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "I_epi42kCOVg8b", + "externalId": "J" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "isGlobal": { + "type": "boolean", + "description": "isGlobal" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "properties": { + "type": "object", + "properties": { + "occaecat_ad": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "occaecat_ad" + }, + "id9": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "id9" + }, + "reprehenderit8": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "reprehenderit8" + }, + "exercitationbe2": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "exercitationbe2" + } + }, + "description": "properties" + }, + "space": { + "type": "string", + "description": "space" + }, + "usedFor": { + "type": "string", + "description": "usedFor" + }, + "name": { + "type": "string", + "description": "name" + }, + "description": { + "type": "string", + "description": "description" + }, + "constraints": { + "type": "object", + "properties": { + "aute_30": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "aute_30" + }, + "ullamco_b": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "ullamco_b" + }, + "officia_638": { + "type": "object", + "properties": { + "require": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + }, + "description": "require" + }, + "constraintType": { + "type": "string", + "description": "constraintType" + } + }, + "description": "officia_638" + } + }, + "description": "constraints" + }, + "indexes": { + "type": "object", + "properties": { + "veniam_01": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "veniam_01" + }, + "culpa_f": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "culpa_f" + }, + "anim_0": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "anim_0" + }, + "nisi__4": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "nisi__4" + }, + "commodo5": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "indexType": { + "type": "string", + "description": "indexType" + }, + "cursorable": { + "type": "boolean", + "description": "cursorable" + } + }, + "description": "commodo5" + } + }, + "description": "indexes" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/containers/delete": { + "post": { + "summary": "Delete containers", + "description": "Delete one or more containers. Currently limited to 100 containers at a time. You cannot delete a container when one or more data model(s) or view(s) references it.", + "operationId": "DeleteContainers", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "I_epi42kCOVg8b", + "externalId": "J" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/containers/indexes/delete": { + "post": { + "summary": "Delete indexes from containers", + "description": "Delete one or more container indexes. Currently limited to 10 indexes at a time.", + "operationId": "DeleteIndexesFromContainers", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "containerExternalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "containerExternalId" + }, + "identifier": { + "type": "string", + "description": "identifier" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "tEyXXYx3QqCbp9BfWWncHX", + "containerExternalId": "T", + "identifier": "culpa aute" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "description": "space" + }, + "containerExternalId": { + "type": "string", + "description": "containerExternalId" + }, + "identifier": { + "type": "string", + "description": "identifier" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/containers/constraints/delete": { + "post": { + "summary": "Delete constraints from containers", + "description": "Delete one or more container constraints. Currently limited to 10 constraints at a time.", + "operationId": "DeleteConstraintsFromContainers", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "containerExternalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "containerExternalId" + }, + "identifier": { + "type": "string", + "description": "identifier" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "space": "tEyXXYx3QqCbp9BfWWncHX", + "containerExternalId": "T", + "identifier": "culpa aute" + } + ] + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "space": { + "type": "string", + "description": "space" + }, + "containerExternalId": { + "type": "string", + "description": "containerExternalId" + }, + "identifier": { + "type": "string", + "description": "identifier" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/instances": { + "post": { + "summary": "Create or update nodes or edges", + "description": "Create or update nodes and edges in a transaction. The ```items``` field of the payload is an array of objects\nwhere each object describes a node or an edge to create, patch or replace. The ```instanceType``` field of\neach object must be ```node``` or ```edge``` and determines how the rest of the object is interpreted.\n\nThis operation is currently limited to 1000 nodes and/or edges at a time.\n\nIndividual nodes and edges are uniquely identified by their externalId and space.\n\n### Creating new instances\n\nWhen there is no node or edge with the given externalId in the given space, a node will be created and the\nproperties provided for each of the containers or views in the ```sources``` array will be populated for the\nnode/edge. Nodes can also be created implicitly when an edge between them is created (if\n```autoCreateStartNodes``` and/or ``` autoCreateEndNodes``` is set), or when a direct relation\nproperty is set, the target node does not exist and ```autoCreateDirectRelations``` is set.\n\nTo add a node or edge, the user must have capabilities to access (write to) both the view(s) referenced in\n```sources``` and the container(s) underlying these views, as well as any directly referenced containers.\n\n### Updating (patching) or replacing instances\n\nWhen a node or edge (instance) with the given externalId already exists in a space, the\nproperties named in the ```sources``` field will be written to the instance. Other properties will remain\nunchanged. To replace the whole set of properties for an instance (a node or an edge) rather than patch the\ninstance, set the ```replace``` parameter to ```true```.\n\nIf you use a writable view to update properties (that is, the source you are referring to in ```sources```\nis a view), you must have write access to the view as well as all of its backing containers.\n\n### No-change patch operations\nWhen a node/edge item has no changes compared to the existing instance - that is, when the supplied property\nvalues are equal to the corresponding values in the existing node/edge, the node/edge will stay unchanged.\nIn this case, the ```lastUpdatedTime``` values for the nodes or edges in question will not change.\n", + "operationId": "CreateOrUpdateNodes_edges", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "items": { + "type": "object" + }, + "description": "items" + }, + "autoCreateDirectRelations": { + "type": "boolean", + "default": true, + "description": "autoCreateDirectRelations" + }, + "autoCreateStartNodes": { + "type": "boolean", + "default": false, + "description": "autoCreateStartNodes" + }, + "autoCreateEndNodes": { + "type": "boolean", + "default": false, + "description": "autoCreateEndNodes" + }, + "skipOnVersionConflict": { + "type": "boolean", + "default": false, + "description": "skipOnVersionConflict" + }, + "replace": { + "type": "boolean", + "default": false, + "description": "replace" + } + }, + "default": { + "items": [ + { + "instanceType": "node", + "space": "kxOLWzfT44d2NLt4NP94NYRL5tbTEHKpUkmH-GhsW", + "externalId": "nXRBi$cnoVgAc]}G7+X~+f)/(o,eDJW?%RLYzs#_U|j y-:>O{(T9W)I+H;-BbJpa-#Q", + "existingVersion": 51868979, + "sources": [ + { + "source": { + "type": "view", + "space": "usmHsK8WeoYbOQlAXUnvqtM06d7PMoHd3Tkd0HBeM6", + "externalId": "BxfQevlY8j3pc0CfwiPHLCXRsS2jIWVIW3tyYFCxRa4jRpH0Egoo8F2riIwz7JATaU7af_MYyUbC4M6mryzck5GrsKuLf1pe7DOx8i3ZgmFJPSHc9j3Mn6uLIWaBRL5lce0P7M0NtpryZFZ3pbYLClWuyroM7Cq1OKqRrA8k7SphZlSNFpXN8zKQXcufG9Rmu38KLeUjdZNBydQQ35a6kq1up9Kza3yFV_ld0VCzsUt90nE", + "version": "p" + }, + "properties": { + "reprehenderit_52": "enim exercitation qui", + "doc1": "cupidatat" + } + } + ] + } + ], + "autoCreateDirectRelations": true, + "autoCreateStartNodes": false, + "autoCreateEndNodes": false, + "skipOnVersionConflict": false, + "replace": false + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "wasModified": { + "type": "boolean", + "description": "wasModified" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + } + } + }, + "description": "items" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + }, + "409": { + "description": "409", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/instances/list": { + "post": { + "summary": "Filter nodes or edges", + "description": "Filter the instances - nodes and edges - in a project.", + "operationId": "FilterNodes_edges", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "includeTyping": { + "type": "boolean", + "default": false, + "description": "includeTyping" + }, + "sources": { + "type": "array", + "maxItems": 10, + "items": { + "type": "object", + "properties": { + "source": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + }, + "description": "source" + } + } + }, + "description": "sources" + }, + "instanceType": { + "type": "string", + "default": "node", + "enum": [ + "node", + "edges" + ], + "description": "instanceType" + }, + "cursor": { + "type": "string", + "description": "cursor" + }, + "limit": { + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "description": "limit" + }, + "sort": { + "type": "array", + "maxItems": 5, + "items": { + "type": "object", + "properties": { + "property": { + "type": "array", + "minItems": 1, + "maxItems": 3, + "items": { + "type": "string" + }, + "description": "property" + }, + "direction": { + "type": "string", + "default": "ascending", + "enum": [ + "ascending", + "descending" + ], + "description": "direction" + }, + "nullsFirst": { + "type": "boolean", + "default": false, + "description": "nullsFirst" + } + } + }, + "description": "sort" + }, + "filter": { + "type": "object", + "description": "filter" + } + }, + "default": { + "includeTyping": false, + "sources": [ + { + "source": { + "type": "view", + "space": "E1Q-CXDmy2fGCFwrkIVRS2mVcj-Xo7Qjdo8gAKGnta8", + "externalId": "QkZ62IzrfBkOKQGYObqMWZOVcY5ziEFGMWY5B2eAdHR_bnX", + "version": "PJ9tTv9roZAfuZQ9CLo4zKayJ3" + } + }, + { + "source": { + "type": "view", + "space": "E1Q-CXDmy2fGCFwrkIVRS2mVcj-Xo7Qjdo8gAKGnta8", + "externalId": "QkZ62IzrfBkOKQGYObqMWZOVcY5ziEFGMWY5B2eAdHR_bnX", + "version": "PJ9tTv9roZAfuZQ9CLo4zKayJ3" + } + } + ], + "instanceType": "node", + "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo", + "limit": 1000, + "sort": [ + { + "property": [ + "ut" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "ut" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "filter": { + "and": [ + { + "value": "" + } + ] + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "nostrudd": { + "type": "object", + "properties": { + "voluptate_9c9": { + "type": "object", + "properties": { + "nisi1": { + "type": "string", + "description": "nisi1" + } + }, + "description": "voluptate_9c9" + } + }, + "description": "nostrudd" + }, + "ex_3": { + "type": "object", + "properties": { + "Duis_45": { + "type": "object", + "properties": { + "anim2": { + "type": "string", + "description": "anim2" + }, + "pariature7e": { + "type": "string", + "description": "pariature7e" + } + }, + "description": "Duis_45" + } + }, + "description": "ex_3" + }, + "ipsum_8": { + "type": "object", + "properties": { + "dolorc6": { + "type": "object", + "properties": { + "dolor5": { + "type": "string", + "description": "dolor5" + }, + "fugiat_f": { + "type": "string", + "description": "fugiat_f" + }, + "Lorem_4": { + "type": "string", + "description": "Lorem_4" + } + }, + "description": "dolorc6" + }, + "ut_a8": { + "type": "object", + "properties": { + "dolore72": { + "type": "string", + "description": "dolore72" + } + }, + "description": "ut_a8" + }, + "anim01d": { + "type": "object", + "properties": { + "deserunt_f3": { + "type": "string", + "description": "deserunt_f3" + }, + "in_bbe": { + "type": "string", + "description": "in_bbe" + }, + "in5": { + "type": "string", + "description": "in5" + } + }, + "description": "anim01d" + } + }, + "description": "ipsum_8" + }, + "ad59": { + "type": "object", + "properties": { + "eiusmod__13": { + "type": "object", + "properties": { + "culpa_858": { + "type": "string", + "description": "culpa_858" + } + }, + "description": "eiusmod__13" + }, + "voluptate_8": { + "type": "object", + "properties": { + "consequat0": { + "type": "string", + "description": "consequat0" + }, + "culpa_e": { + "type": "string", + "description": "culpa_e" + } + }, + "description": "voluptate_8" + }, + "utc": { + "type": "object", + "properties": { + "aute__f9": { + "type": "string", + "description": "aute__f9" + }, + "minim_8a": { + "type": "string", + "description": "minim_8a" + } + }, + "description": "utc" + } + }, + "description": "ad59" + }, + "in_b_2": { + "type": "object", + "properties": { + "ut_": { + "type": "object", + "properties": { + "do_5": { + "type": "string", + "description": "do_5" + }, + "in8": { + "type": "string", + "description": "in8" + } + }, + "description": "ut_" + }, + "aute_9": { + "type": "object", + "properties": { + "enim09": { + "type": "string", + "description": "enim09" + }, + "pariatur_2": { + "type": "string", + "description": "pariatur_2" + }, + "nulla_6": { + "type": "string", + "description": "nulla_6" + } + }, + "description": "aute_9" + } + }, + "description": "in_b_2" + } + }, + "description": "properties" + } + } + }, + "description": "items" + }, + "typing": { + "type": "object", + "properties": { + "id58": { + "type": "object", + "properties": { + "dolor9": { + "type": "object", + "properties": { + "cillum_e1a": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "cillum_e1a" + }, + "nisi_6_3": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "nisi_6_3" + }, + "ex5fb": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "ex5fb" + } + }, + "description": "dolor9" + }, + "dolore_": { + "type": "object", + "properties": { + "eu164": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "eu164" + } + }, + "description": "dolore_" + } + }, + "description": "id58" + }, + "sint__": { + "type": "object", + "properties": { + "consequata": { + "type": "object", + "properties": { + "Loremd": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "Loremd" + }, + "enima": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "enima" + } + }, + "description": "consequata" + }, + "Duis_baa": { + "type": "object", + "properties": { + "reprehenderit_a": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "reprehenderit_a" + } + }, + "description": "Duis_baa" + } + }, + "description": "sint__" + } + }, + "description": "typing" + }, + "nextCursor": { + "type": "string", + "description": "nextCursor" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/instances/byids": { + "post": { + "summary": "Retrieve nodes or edges by their external ids", + "description": "Retrieve up to 1000 nodes or edges by their external ids.", + "operationId": "RetrieveNodes_edgesByTheirExternalIds", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "default": "node", + "enum": [ + "node", + "edge" + ], + "description": "instanceType" + }, + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[^\\\\x00]{1,255}$", + "description": "externalId" + } + } + }, + "description": "items" + }, + "sources": { + "type": "array", + "maxItems": 10, + "items": { + "type": "object", + "properties": { + "source": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + }, + "description": "source" + } + } + }, + "description": "sources" + }, + "includeTyping": { + "type": "boolean", + "default": false, + "description": "includeTyping" + } + }, + "default": { + "items": [ + { + "instanceType": "node", + "space": "gukWzBmFiYDbfcvPdBVe94jUYWf", + "externalId": "*YQ6Y}C,`2Bk!E3K|?4`=8dYh3I}.1/ /YH%==f>6`w`Q|`*k9&Ype)@In?lrtn7_a*`/2{Gup[Mi9C8w&m2{.K?`;9)Msd7D2L}T^|(1l-3fiY%J@S18~UE;}7O==vPi9uu\"gNi-V8/XF>e'wJ:2" + } + ], + "sources": [ + { + "source": { + "type": "view", + "space": "zUi8wFyMKmTCYOWpOpPP7N", + "externalId": "S", + "version": "YJm-syGn43Qpxp9Bw8vouL1EtLTYciVe" + } + }, + { + "source": { + "type": "view", + "space": "zUi8wFyMKmTCYOWpOpPP7N", + "externalId": "S", + "version": "YJm-syGn43Qpxp9Bw8vouL1EtLTYciVe" + } + } + ], + "includeTyping": false + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "minim_f": { + "type": "object", + "properties": { + "aute_7": { + "type": "object", + "properties": { + "incididunt5a": { + "type": "string", + "description": "incididunt5a" + }, + "ullamco_4b4": { + "type": "string", + "description": "ullamco_4b4" + } + }, + "description": "aute_7" + }, + "quis_8": { + "type": "object", + "properties": { + "enim_a2_": { + "type": "string", + "description": "enim_a2_" + } + }, + "description": "quis_8" + }, + "irure_dc": { + "type": "object", + "properties": { + "adipisicing6": { + "type": "string", + "description": "adipisicing6" + }, + "commodo_e": { + "type": "string", + "description": "commodo_e" + } + }, + "description": "irure_dc" + }, + "incididuntf": { + "type": "object", + "properties": { + "aliquaf": { + "type": "string", + "description": "aliquaf" + }, + "anim097": { + "type": "string", + "description": "anim097" + } + }, + "description": "incididuntf" + }, + "Excepteurc94": { + "type": "object", + "properties": { + "fugiat_c": { + "type": "string", + "description": "fugiat_c" + }, + "cillum_d": { + "type": "string", + "description": "cillum_d" + } + }, + "description": "Excepteurc94" + } + }, + "description": "minim_f" + }, + "nisi6": { + "type": "object", + "properties": { + "fugiat5": { + "type": "object", + "properties": { + "eiusmod_d9b": { + "type": "string", + "description": "eiusmod_d9b" + } + }, + "description": "fugiat5" + }, + "sunt__b4": { + "type": "object", + "properties": { + "sint_d7": { + "type": "string", + "description": "sint_d7" + } + }, + "description": "sunt__b4" + } + }, + "description": "nisi6" + }, + "Duis_7": { + "type": "object", + "properties": { + "quis_f": { + "type": "object", + "properties": { + "non6": { + "type": "string", + "description": "non6" + } + }, + "description": "quis_f" + }, + "irure6": { + "type": "object", + "properties": { + "est88": { + "type": "string", + "description": "est88" + }, + "adipisicing__ec": { + "type": "string", + "description": "adipisicing__ec" + } + }, + "description": "irure6" + } + }, + "description": "Duis_7" + }, + "sint_0ff": { + "type": "object", + "properties": { + "non0": { + "type": "object", + "properties": { + "fugiat_4": { + "type": "string", + "description": "fugiat_4" + }, + "ullamco__46": { + "type": "string", + "description": "ullamco__46" + }, + "tempor3e": { + "type": "string", + "description": "tempor3e" + } + }, + "description": "non0" + } + }, + "description": "sint_0ff" + }, + "ipsum_e9": { + "type": "object", + "properties": { + "consequat__b": { + "type": "object", + "properties": { + "fugiat6": { + "type": "string", + "description": "fugiat6" + } + }, + "description": "consequat__b" + }, + "incididunt_1c": { + "type": "object", + "properties": { + "quis_26": { + "type": "string", + "description": "quis_26" + }, + "do_8": { + "type": "string", + "description": "do_8" + } + }, + "description": "incididunt_1c" + } + }, + "description": "ipsum_e9" + }, + "in_05": { + "type": "object", + "properties": { + "consequat_e2": { + "type": "object", + "properties": { + "in_2": { + "type": "string", + "description": "in_2" + }, + "pariatur_c11": { + "type": "string", + "description": "pariatur_c11" + }, + "commodoc4a": { + "type": "string", + "description": "commodoc4a" + } + }, + "description": "consequat_e2" + }, + "elit_b3": { + "type": "object", + "properties": { + "deserunt8": { + "type": "string", + "description": "deserunt8" + } + }, + "description": "elit_b3" + }, + "amet6d": { + "type": "object", + "properties": { + "laboris_d": { + "type": "string", + "description": "laboris_d" + }, + "doloreb0": { + "type": "string", + "description": "doloreb0" + } + }, + "description": "amet6d" + }, + "id_975": { + "type": "object", + "properties": { + "sed_6c": { + "type": "string", + "description": "sed_6c" + }, + "eu78": { + "type": "string", + "description": "eu78" + }, + "enim4b": { + "type": "string", + "description": "enim4b" + } + }, + "description": "id_975" + } + }, + "description": "in_05" + } + }, + "description": "properties" + } + } + }, + "description": "items" + }, + "typing": { + "type": "object", + "properties": { + "exercitationc_d": { + "type": "object", + "properties": { + "proident_21": { + "type": "object", + "properties": { + "commodo_21": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "commodo_21" + }, + "id89": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "id89" + } + }, + "description": "proident_21" + } + }, + "description": "exercitationc_d" + }, + "labore_bfa": { + "type": "object", + "properties": { + "est4fc": { + "type": "object", + "properties": { + "anim_112": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "anim_112" + }, + "culpa_e7d": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "culpa_e7d" + }, + "in1e5": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "in1e5" + } + }, + "description": "est4fc" + }, + "exercitation_72": { + "type": "object", + "properties": { + "nulla_78": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "nulla_78" + }, + "id__": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "id__" + } + }, + "description": "exercitation_72" + }, + "adipisicing_e": { + "type": "object", + "properties": { + "sint9_b": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "sint9_b" + }, + "in_44": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "in_44" + }, + "proident_8e": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "proident_8e" + }, + "minim126": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "minim126" + }, + "eiusmod_6": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "eiusmod_6" + } + }, + "description": "adipisicing_e" + } + }, + "description": "labore_bfa" + }, + "consequat2": { + "type": "object", + "properties": { + "officia68": { + "type": "object", + "properties": { + "exercitation069": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "exercitation069" + } + }, + "description": "officia68" + } + }, + "description": "consequat2" + } + }, + "description": "typing" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/instances/search": { + "post": { + "summary": "Search for nodes or edges", + "description": "Search text fields in views for nodes or edge(s). The service will return up to 1000 results. This operation orders the results by relevance, across the specified spaces.", + "operationId": "SearchForNodes_edges", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "view": { + "type": "object", + "properties": { + "type": { + "type": "string", + "title": "view type", + "description": "type" + }, + "space": { + "type": "string", + "title": "view space", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "title": "view externalId", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "title": "view version", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + }, + "description": "view" + }, + "query": { + "type": "string", + "description": "query" + }, + "instanceType": { + "type": "string", + "default": "node", + "enum": [ + "node", + "edge" + ], + "description": "instanceType" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "properties" + }, + "filter": { + "type": "object", + "description": "filter" + }, + "limit": { + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "description": "limit" + } + }, + "default": { + "view": { + "type": "view", + "space": "IU05I9lZ7XnaW92pyAwtbKnw2n8GAQ7dOJYg4_j", + "externalId": "F", + "version": "Vj2UNRbSwERTWS-feQDG2PFBk9" + }, + "query": "do consequat tempor ipsum", + "instanceType": "node", + "properties": [ + "ut", + "Duis culpa" + ], + "filter": { + "and": [ + { + "value": "" + } + ] + }, + "limit": 1000 + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "ipsum_20": { + "type": "object", + "properties": { + "pariatur_39": { + "type": "object", + "properties": { + "quis7bb": { + "type": "string", + "description": "quis7bb" + } + }, + "description": "pariatur_39" + } + }, + "description": "ipsum_20" + }, + "enim_8": { + "type": "object", + "properties": { + "laborum__91": { + "type": "object", + "properties": { + "proidentb48": { + "type": "string", + "description": "proidentb48" + }, + "deserunt_4": { + "type": "string", + "description": "deserunt_4" + }, + "doc1": { + "type": "string", + "description": "doc1" + } + }, + "description": "laborum__91" + } + }, + "description": "enim_8" + }, + "reprehenderit_1fb": { + "type": "object", + "properties": { + "Lorem83c": { + "type": "object", + "properties": { + "consecteturd35": { + "type": "string", + "description": "consecteturd35" + }, + "culpac": { + "type": "string", + "description": "culpac" + } + }, + "description": "Lorem83c" + } + }, + "description": "reprehenderit_1fb" + } + }, + "description": "properties" + } + } + }, + "description": "items" + }, + "typing": { + "type": "object", + "properties": { + "ametae9": { + "type": "object", + "properties": { + "anim_3e": { + "type": "object", + "properties": { + "cupidatat97": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "cupidatat97" + } + }, + "description": "anim_3e" + }, + "aute7c": { + "type": "object", + "properties": { + "ea0": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "ea0" + }, + "nisif": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "nisif" + }, + "qui92_": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "qui92_" + } + }, + "description": "aute7c" + } + }, + "description": "ametae9" + }, + "nisi_c": { + "type": "object", + "properties": { + "occaecat_8": { + "type": "object", + "properties": { + "pariatur_525": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "pariatur_525" + }, + "nisi_c6": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "nisi_c6" + } + }, + "description": "occaecat_8" + } + }, + "description": "nisi_c" + } + }, + "description": "typing" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/instances/aggregate": { + "post": { + "summary": "Aggregate data across nodes or edges", + "description": "Aggregate data for nodes or edges in a project. You can use an optional query or filter specification to limit the result.", + "operationId": "AggregateDataAcrossNodes_edges", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "view": { + "type": "object", + "properties": { + "type": { + "type": "string", + "title": "view type", + "description": "type" + }, + "space": { + "type": "string", + "title": "view space", + "minItems": 1, + "maxItems": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "title": "view externalId", + "minItems": 1, + "maxItems": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "description": "externalId" + }, + "version": { + "type": "string", + "title": "view version", + "minItems": 1, + "maxItems": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "description": "version" + } + }, + "description": "view" + }, + "query": { + "type": "string", + "description": "query" + }, + "properties": { + "type": "array", + "minItems": 1, + "maxItems": 200, + "items": { + "type": "string" + }, + "description": "properties" + }, + "limit": { + "type": "integer", + "format": "int32", + "default": 100, + "minimum": 1, + "maximum": 1000, + "description": "limit" + }, + "aggregates": { + "type": "array", + "maxItems": 5, + "items": { + "type": "object" + }, + "description": "aggregates" + }, + "groupBy": { + "type": "array", + "minItems": 1, + "maxItems": 5, + "items": { + "type": "string" + }, + "description": "groupBy" + }, + "filter": { + "type": "object", + "description": "filter" + }, + "instanceType": { + "type": "string", + "default": "node", + "enum": [ + "node", + "edge" + ], + "description": "instanceType" + } + }, + "default": { + "view": { + "type": "view", + "space": "EYgLQ4m", + "externalId": "I", + "version": "p" + }, + "query": "culpa veniam eu", + "properties": [ + "nos" + ], + "limit": 100, + "aggregates": [ + { + "avg": { + "property": "enim fugiat eiusmod ut pariatur" + } + }, + { + "avg": { + "property": "enim fugiat eiusmod ut pariatur" + } + } + ], + "groupBy": [ + "culpa sint" + ], + "filter": { + "and": [ + { + "value": "" + } + ] + }, + "instanceType": "node" + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "aggregates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "aggregate": { + "type": "string", + "description": "aggregate" + }, + "property": { + "type": "string", + "description": "property" + }, + "value": { + "type": "number", + "format": "float", + "description": "value" + } + } + }, + "description": "aggregates" + }, + "group": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name" + }, + "tag": { + "type": "string", + "description": "tag" + } + }, + "description": "group" + } + } + }, + "description": "items" + }, + "typing": { + "type": "object", + "properties": { + "dolore_7d": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "dolore_7d" + }, + "tempor560": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "list": { + "type": "boolean", + "description": "list" + }, + "collation": { + "type": "string", + "description": "collation" + } + }, + "description": "type" + }, + "nullable": { + "type": "boolean", + "description": "nullable" + }, + "autoIncrement": { + "type": "boolean", + "description": "autoIncrement" + }, + "defaultValue": { + "type": "string", + "description": "defaultValue" + }, + "description": { + "type": "string", + "description": "description" + }, + "name": { + "type": "string", + "description": "name" + } + }, + "description": "tempor560" + } + }, + "description": "typing" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/instances/delete": { + "post": { + "summary": "Delete nodes or edges", + "description": "Delete nodes and edges in a transaction. Limited to 1000 nodes or edges at a time.\n\n\nWhen a node is selected for deletion, all connected incoming and outgoing edges that point to or from it are also deleted. However, please note that the operation might fail if the node has a high number of edge connections. If this is the case, consider deleting the edges connected to the node before deleting the node itself. ", + "operationId": "DeleteNodes_edges", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "default": "node", + "enum": [ + "node", + "edge" + ], + "description": "instanceType" + }, + "space": { + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "description": "space" + }, + "externalId": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[^\\\\x00]{1,255}$", + "description": "externalId" + } + } + }, + "description": "items" + } + }, + "default": { + "items": [ + { + "instanceType": "node", + "space": "mbeRmSDGdV6lqhQ0U_2r14ujOn", + "externalId": "plIQ`czhk$@sH8`~G+R=kq@?Iyl%GmyRA?W7R`@J[[qH}M!>2RYD@SP/7fM!-'Ge$=C5[hH qaAqoD@Y21Q)t7w%Ez (v.t3$13 Bob\n Bob -fancies-> Mallory\n```\n\nGiven the above graph, if you follow any edge from `Bob` _outwards_ (which is default), you'll get the edges \n`Bob -fancies-> Mallory`. If you follow edges inwards, i.e. `direction=inwards`, you'll get `Alice -is-parent-> Bob`.\n\nThe traversal happens breadth first. See [limitations](#limitations) for more details.\n\nA traversal is defined by what edges to follow, what nodes to match, and what nodes to terminate traversal at.\n\nThis is controlled by `filter`, `nodeFilter` and `terminationFilter`.\n\n`filter` is a filter on edges. You would typically filter on the property `[edge, type]`, but any property on an edge \ncan be filtered on.\n\n`nodeFilter` is a node filter, which the node on the \"other\" side must match. With `direction: outwards`, that means \nthe \"end node\" of the edge must match. With `direction: inwards`, the \"start node\" must match.\n\n`terminationFilter` is similar to `nodeFilter`, except if it matches, traversal will end. A node must also match \n`nodeFilter` (if any) to steer the traversal to the node to terminate at in the first place.\n\n`maxDistance` controls how many hops away from the initial set traversal will go. `maxDistance` defaults to unlimited \n(but the set must respect its `limit`, defined on the result set expression). If `maxDistance` is 1, execution might \nbe faster, so if you know there will only be one level, it's worth configuring `maxDistance: 1`.\n\nFull options:\n\n- `from`: Result set expression to chain from.\n- `filter`: Edges traversed must match this filter.\n- `nodeFilter`: Nodes on the \"other\" side of the edge must match this filter.\n- `terminationFilter`. Do not traverse beyond nodes matching this filter.\n- `maxDistance`: How many levels to traverse. Default unlimited.\n- `direction`: Whether to traverse edges pointing out of the initial set, or _into_ the initial set.\n- `limitEach`: Limit the number of returned edges for each of the source nodes in the result set. The indicated uniform\nlimit applies to the result set from the referenced from. limitEach only has meaning when you also specify \nmaxDistance=1 and from.\n\n## Selects\nSelect configurations appear directly below `select` in a query. These specify which data to retrieve for the respective\nresult set expression. It specifies a number of sources (views) and a property selector for each of these. The property\nselectors define which view properties will be emitted in the query result.\n\nIt's possible to have sets whose properties are not emitted. This can be useful if the sets are necessary for chaining,\nbut not actually interesting to include in the final results. Sets that are neither chained nor selected\nwill not be executed (but will cause very slight query processing overhead)\n\nResults are grouped by their respective sets, and the results contain properties that match the property selectors for\nthe set.\n\n\n## Filters\n\nFilters define what a part of the query matches. Filters are tree structures where the operator comes first, and then \nthe parameters for that operator.\n\nA simple example is the `in` filter:\n\n```yaml\nin:\n property: [node, name]\n values: [movie]\n```\n\nIf the property `node.name`, which is text property, is equal to any of the values in the provided list, the node will \nmatch. Properties are typed. What query operators you can use on a property depends on its type.\n\nAn exhaustive list of filters and their descriptions can be found by examining the request body schema below.\n\n### Compound filters\n\nFilters can be combined with `and`/`or`/`not`:\n\n```yaml\nand:\n - not:\n in:\n property: [node, type]\n values: [movie]\n - range:\n property: [imdb, movie, released]\n gte: {parameter: start}\n```\n\nThis would correspond to `(NOT node.type in ('movie')) AND imdb.movie.released >= $start`.\n\n### HasData filter\nAlthough this filter is documentented in the request body schema, it merits a more detailed explanation. \nA `hasData` filters will match if data is present in a given set of containers or views.\n\nThere is an implicit `AND` between the containers and views referenced in the filter, so the filter will match\nif and only if the node/edge has data in _all_ of the specified containers and views.\n\nWhen a container is specified, the filter will match if the instance has all required properties populated\nfor that particular container. \n\nWhen a view is specified, the filter will match nodes with data in all of the containers which the view references \nthrough properties, respecting the filters of the view if defined (and the filters of views implemented by the view).\n\nExample:\n\n```yaml\nhasData:\n - type: container\n space: my_space\n externalId: my_container\n - type: view\n space: my_space\n externalId: my_view\n version: v1\n```\n\nIf `my_space.my_view.v1` maps properties in the containers `my_space.c1` and `my_space.c2`. The filter will match\nif there is data in `my_space.my_container AND (my_space.c1 AND my_space.c2)` if there is no filter defined on \n`my_space.my_view.v1`, and `my_space.my_container AND my_space.my_view.v1.filter` if there is a filter defined on\n`my_space.my_view.v1`.\n\n### Parameters\n\nValues in filters can be parameterised. Parameters are provided as part of the query object, and not in the filter \nitself.\n\nThis filter is parameterised:\n\n```yaml\nrange:\n property: [imdb, movie, released]\n gte: {parameter: start}\n```\n\nA query containing this filter will only run if the parameter `start` is provided. The parameter must be compatible \nwith all the types and operators that refer to the parameter. In the above example, the \"released\" property is a date. \nThus, the start parameter must be compatible with the date type, or the query will fail completely, even if the range \nfilter is optional because it's OR-ed\n___\n**TIP**\n\n Parameterise your filters!\nIt's a best practice to parameterise queries that take user input. This enables reusing query plans across queries, \nwhich will be noticable with read-heavy workloads.\n___\n\n\n## Sorting and Limiting\n\nSorting and limiting can happen in multiple places in a query:\n\n- In the result set expression, i.e. in the `with` object that defines a node or edge set.\n- In the result selection, i.e. under `select` where defined sets can be emitted as results.\n\nSorting and limiting the set definitions under `with` will transitively affect dependent sets.\n\nChanges to a set defined under `with` will naturally affect sets that depend on it, transitively. If you only change \nthe sort order of a `with` expression, dependent sets will not (necessarily) change (based on how the dependent sets \nare defined), but if you put a limit on an expression, all dependent sets will inherit this and change as a consequence.\n\nThis is also true for sets that aren't actually emitted via `select`, i.e. sets that are only defined as stepping-stones\nfor other sets.\n\nSorts and limits defined under `select` changes the result appearing order for that set only, and _not_ for depending \nsets.\n\nExample:\n\n```yaml\nwith:\n some_nodes:\n … # omitted. No sort here\n some_edges:\n from: some_nodes\n # omitted. also no sorting\n target_nodes:\n from: some_edges\n # …\nselect:\n some_nodes:\n properties: ...\n sort:\n - {property: [node, created], direction: descending}\n limit: 100\n```\n\nThe above query would still let `some_edges` and `target_nodes` pull from the full amount of nodes in `some_nodes`, \neven though what's returned as a result for `some_nodes` is capped at 100.\n\n### Order of sorting and limiting\n\n---\n**NOTE**\n\n A limit in an edge traversal applies to when to start traversing, which happens before sorting.\n\n---\nNodes and edges have subtly different sorting and limiting behaviour: Nodes sort and limit simultaneously, while \nrecursive edge exploration do limited traversal, _then_ sort.\n\nThe top-n set of nodes sorted by some property will be guaranteed to have the top-n of that property for the set.\n\nFor edges found through traversal, i.e. via `edges`, the `limit` applies to how many edges to discover. This may not \nbe all the edges that _could_ have been discovered in a full traversal. If you start traversing from some node and ask\nfor 100 edges sorted by creation timestamp, the 100 edges discovered before traversal stops get sorted. The full graph \nis _not_ traversed in order to find the 100 newest edges that exist in the graph defined by the traversal filters.\n\nTherefore, to do sorting with a recursive graph traversal, you'll need to specify the sort configuration via `postSort`.\n\nAn edge traversal with `maxDistance=1` can take a normal `sort` configuration, however.\n\n\n## Limitations\n\n### Graph traversal\nAny query that involves a graph traversal will force nested loop-style execution. This will work well enough for \ntraversals limited to a few hundred thousand unique paths.\n\nThe graph traversal is breadth first. All possible paths are traversed. This is important to keep in mind with \ntraversals across loops. For example, a fully connected graph will not do well in a query that follows all possible \npaths, and is very likely to be terminated due to constraints on either time, memory, or temporary disk usage.\n\n### Timeout errors\n\nQueries get cancelled with a 408 Request Timeout error if they take longer than the timeout.\nIf hitting a timeout like this you will need to reduce load or contention, or optimise your query.", + "operationId": "QueryNodes_edges", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "with": { + "type": "object", + "minItems": 1, + "maxItems": 20, + "description": "with" + }, + "select": { + "type": "object", + "minItems": 1, + "maxItems": 20, + "description": "select" + }, + "cursors": { + "type": "object", + "maxItems": 20, + "description": "cursors" + }, + "parameters": { + "type": "object", + "description": "parameters" + } + }, + "default": { + "with": { + "labore_1e": { + "nodes": { + "from": "velit dolor aliquip quis est", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "J0RyBIrwJ0", + "externalId": "HsepDd4txO_C_hVY8FSUpxp3YE0ahA0O4MfwVJQAIsz9IAKGPvGPnL2ei0CzHtRz7jy8", + "version": "R0fVCU" + }, + "identifier": "B" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "sit qui dolore" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "sit qui dolore" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -59945520 + }, + "aliqua_6": { + "nodes": { + "from": "id", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "OOxyg4qzpabjonnwtiyBGgAdwBkF7XvWB", + "externalId": "Jmc2g_avjmcRUir_Ex1e0k9ukpDbJ5qzmkckwHcefEeWR2qoA2WOroHz2ejOSWerfe3KEvbeJZceC5JWH4ShYdnuUUy4HPKp7sEznJbKmTujknin6CocdfsX2Idn9Eqt9XH7ARU0Bluuq0Gkz2m76sbXPvEBFBO0LayYyFXmzp3z5MRJe5UUkP8SWLtzs733CDt48lcpDQmtL9_RbGNxoOnXPhbJjEESkederMactG2QJ3MsjOigq", + "version": "nB_QjVQirzb1U5uxQ.fR4I-j0cP" + }, + "identifier": "JXIxST3GzNuJ9BRGiQDVbXy0rlR4kRiAYqh6trnnjk_YFymHUU4Esj7u_IQX60ewQ7rIDoECd8oSxUGEMqTBdgnp6Prc29t9W4qg4WdTWlc9M7U6yV36TtCJDUaumN3cJRw7LgrAn1G6u7dD785sADIYDBDsF3_1HrqKw6" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "sed dolor tempor" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "sed dolor tempor" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -48205270 + }, + "cupidatat_64": { + "nodes": { + "from": "do fugiat", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "azkvvzEffhe-6L7E81A4iCDSPK", + "externalId": "d", + "version": "PG5QAxkn0kaS" + }, + "identifier": "w" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "nostrud" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "nostrud" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 40936165 + }, + "consectetur_6e": { + "nodes": { + "from": "veniam adipisicing", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "kp9L0ai3Eh1", + "externalId": "uUl0H0IOk6UkX7FDoS4Yly3cnMRIyxPNZYOlO9Wmrn_TMwqEdcEXCJqSpOz", + "version": "Z" + }, + "identifier": "H" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "in" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "in" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -9346721 + }, + "nostrud747": { + "nodes": { + "from": "incididunt mollit dolor sit", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "SHMgYgLGyLSC4UGt6A0IV7-8", + "externalId": "p", + "version": "FsJHzYyeG-Bi5P4.aq_ULkL7npLCeEHduS" + }, + "identifier": "cgU3LS5RPvYc6NVA_uW1lqRDzb3V8dvhRd5jvSdzoBxsQd5Lojlj0aRUjb36uitVYwroxB4aUDg_0jMEkJUZ6en56KRTWBAwhHMO2555Rs" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "dolor" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "dolor" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 2441420 + }, + "Utd": { + "nodes": { + "from": "dolor commodo et", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "Z214obe59b8KgDhX2ZBXSr_reS", + "externalId": "BkQhYdH75hWtsh9WmTAgP2SO3XAcy3Yq0ga6Fztk_RSkjmS8yUCf6iLSMAszsA5tzWMiil5HqyHnIpC7STPEkVQG4HiG10eQUoDGF1xOHAPzJEmkuL1iLZJ1HkFYQBMvIGh89n4H_VfQ8avd9fkeHNSH01M6cj6krN5TIgo4gdihaJMSYFA9nsbCszGiuD", + "version": "X" + }, + "identifier": "d15tTl6vJ04js6JSKOjKl31EkQbWDRm02DRL0sciq7czi4Q4lg7MlsfC0TYM04BPzo_ukb8EBCv67a55FKajjKdKCgK6OHxqG9Lgyylwa2fyHUKNNXRGGLR4oreTub2CUHfUz29kDQf486T2w1f_QsHpvLTGq6yE2lWz6XofNV_Dhm" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "qui esse ipsum" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "qui esse ipsum" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 98799841 + }, + "ad_55": { + "nodes": { + "from": "esse", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "Oau5mpQ1WuEdFzj2cVS", + "externalId": "MT48LAz1q_yXYvGeo0O5MRk1Fj", + "version": "AakDSJJ_M-3IJ4pX400tF554vRCLzBocq" + }, + "identifier": "KCeJ260S5P5HoYWA7MVX1AmnI73ED63P4MPYfIRkGKsfPYzO0atfIYZBkamORmaS85ZGEO6ndPoDl5VXJHSzoVU4YbDPtz1QYcfAWI3zlQtBIquJiYsyJWt_5PTNg2f" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "ad sunt" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "ad sunt" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -71021023 + }, + "euc": { + "nodes": { + "from": "enim culpa", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "xPpKA16bAkqoWE2U8OFudMGnXzkzzzCAHcf", + "externalId": "b", + "version": "v" + }, + "identifier": "vykFsXzZXWFuDclHsTw164eDY3FLByK40rjvoH_kKh1Xv2M04FsORTTcvaXVUllrO61doitQ8BigRdGGm" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "sunt occaecat" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "sunt occaecat" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 61654015 + }, + "reprehenderitccc": { + "nodes": { + "from": "in incididunt tempor nostrud", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "v418a8fuwLAPxPZMakNiAu5iu6fip9jtVJHeyEIzVD", + "externalId": "N", + "version": "YBQwhRNJPI0" + }, + "identifier": "w" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "in amet ea aliqua" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "in amet ea aliqua" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 52345904 + }, + "et_319": { + "nodes": { + "from": "sunt", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "ueegoPZoccAjwz4d0yVtgC2F0gcZQmcB3RRgB0W", + "externalId": "n", + "version": "G" + }, + "identifier": "U" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "pariatur amet" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "pariatur amet" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 27714989 + }, + "sed46": { + "nodes": { + "from": "in proident ad cupidatat", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "eI", + "externalId": "I68QkrPbQweBzofTGVuEeqPtCJIrBN8HaWiBuBYTsU7b", + "version": "gvbpFoK5qVlwcdexQKgp7whlXrRRcbG8YZ" + }, + "identifier": "gRBD7kQ6isVqK52ec6mpyu_S_USyMx_pNPglFW61kNSd2w8ZenGsvAui1uTZqh7eo6de6rqlNyFwKLBfut2CIVet5kghhsad0Qw_JWELzjGklX1Kjf6_ojzGgWQsxMsBOKkgwz5tgnlSRSuM9sylMTq4GdcMg29gbG1DbDjKrnqIbcMuqKXESVfLqP2qigN0Twaol0hJDvmRlGP2F2zR3ZMfhbg9gJKNSd6mEar60fRD2HGqVmDwid_4K7RHgC" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "sit sunt qui veniam" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "sit sunt qui veniam" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -12034680 + }, + "sed05_": { + "nodes": { + "from": "Lorem reprehenderit", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "Lz0oMWGoXO_hLg5nJnvJkxu", + "externalId": "sTfW0hmrBwna1BGz0wq65aPaoVPBwGCe159iLLLxwbe6HS8XW_aBUOopRmL1cxyfke8WiBJg7iQXLbLrXsPz56SNPX3opzitJT04fxSNN7qhUaGMN_CTorxMHNsTRk000TZtOnxDbuikcvzAJhaVV9LDhJgB29QG1RvB28lgioImeX8Y1tTK2q4jmp2Nft1lf0cliVf9LB6s9K", + "version": "uWnz1fw.YGw" + }, + "identifier": "cdRrs9J7HtR9tO0TFNH4XdmilstLrMBiu" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "culpa tempor dolore" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "culpa tempor dolore" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -55789788 + }, + "nostrude": { + "nodes": { + "from": "laboris laborum", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "dBV4bOazWsh3ak-7kjxNocMlW", + "externalId": "J", + "version": "R" + }, + "identifier": "g" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "sort": [ + { + "property": [ + "Duis velit fugiat" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "Duis velit fugiat" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 54742151 + } + }, + "select": { + "eiusmod_c": { + "sources": [ + { + "source": { + "type": "view", + "space": "HCH40BCh5vTH-7uz", + "externalId": "M5LayULensMDc9dLR9Namr0A2WCGx7diAH84QIyipJCFz_sXysUN3T1QAw1GQdyOG7lasZOkU1pVGFSv_QStF96le1uGZSpcIvRhEPOdPwhX8mMzxUyJdwB4YOEYs6hSc2B5giUwvF4VyC1BP30siWELR2WsZHmOUPp9nJ4fxdWecPB0hXo6OHTx0xLNWJaOBO7wqFjK7An5ANKFVS6ih5f1Z0kegLCMH", + "version": "c" + }, + "properties": [ + "mollit dolore consequat", + "officia fugiat" + ] + }, + { + "source": { + "type": "view", + "space": "HCH40BCh5vTH-7uz", + "externalId": "M5LayULensMDc9dLR9Namr0A2WCGx7diAH84QIyipJCFz_sXysUN3T1QAw1GQdyOG7lasZOkU1pVGFSv_QStF96le1uGZSpcIvRhEPOdPwhX8mMzxUyJdwB4YOEYs6hSc2B5giUwvF4VyC1BP30siWELR2WsZHmOUPp9nJ4fxdWecPB0hXo6OHTx0xLNWJaOBO7wqFjK7An5ANKFVS6ih5f1Z0kegLCMH", + "version": "c" + }, + "properties": [ + "mollit dolore consequat", + "officia fugiat" + ] + } + ], + "sort": [ + { + "property": [ + "ut sint ipsum dolor" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "ut sint ipsum dolor" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 14818095 + }, + "commodo_3": { + "sources": [ + { + "source": { + "type": "view", + "space": "RpB1zTh_Mu9JcxMgYm7RQ8k", + "externalId": "WAtQDm4ULsCeqke0v9BkIFe19", + "version": "lajnxmPkhq.nb59HU64.mrc2J_6NXX" + }, + "properties": [ + "Duis cillum al", + "ad est Duis amet" + ] + }, + { + "source": { + "type": "view", + "space": "RpB1zTh_Mu9JcxMgYm7RQ8k", + "externalId": "WAtQDm4ULsCeqke0v9BkIFe19", + "version": "lajnxmPkhq.nb59HU64.mrc2J_6NXX" + }, + "properties": [ + "Duis cillum al", + "ad est Duis amet" + ] + } + ], + "sort": [ + { + "property": [ + "laborum sint ad et" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "laborum sint ad et" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 9590615 + }, + "sedb": { + "sources": [ + { + "source": { + "type": "view", + "space": "FuHCT7d77u5NOtm2", + "externalId": "M", + "version": "b" + }, + "properties": [ + "Lorem eiusmod irure", + "ex" + ] + }, + { + "source": { + "type": "view", + "space": "FuHCT7d77u5NOtm2", + "externalId": "M", + "version": "b" + }, + "properties": [ + "Lorem eiusmod irure", + "ex" + ] + } + ], + "sort": [ + { + "property": [ + "aliqua dolore proident ullamco pariatur" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "aliqua dolore proident ullamco pariatur" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 54208854 + }, + "culpaa9_": { + "sources": [ + { + "source": { + "type": "view", + "space": "gwmYamSa6YPDvi9MwJAGQatGIgMBF-ExiQX", + "externalId": "a", + "version": "MDj8Jfs_HQqKWg3oNAap6X0Xfb-h" + }, + "properties": [ + "anim", + "ea in dolore" + ] + }, + { + "source": { + "type": "view", + "space": "gwmYamSa6YPDvi9MwJAGQatGIgMBF-ExiQX", + "externalId": "a", + "version": "MDj8Jfs_HQqKWg3oNAap6X0Xfb-h" + }, + "properties": [ + "anim", + "ea in dolore" + ] + } + ], + "sort": [ + { + "property": [ + "Lorem exercitation magna dolore" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "Lorem exercitation magna dolore" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 38947237 + }, + "ex_e78": { + "sources": [ + { + "source": { + "type": "view", + "space": "jQAsMJDkd", + "externalId": "l", + "version": "A" + }, + "properties": [ + "velit voluptate", + "anim nulla reprehenderit" + ] + }, + { + "source": { + "type": "view", + "space": "jQAsMJDkd", + "externalId": "l", + "version": "A" + }, + "properties": [ + "velit voluptate", + "anim nulla reprehenderit" + ] + } + ], + "sort": [ + { + "property": [ + "magna ipsum Excepteur" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "magna ipsum Excepteur" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 96288804 + }, + "in36": { + "sources": [ + { + "source": { + "type": "view", + "space": "zX5YAWCTzUsUtiqeI__9MYzWP6aqbBfk6A", + "externalId": "snbC_UjHDBisKLYGaAIpXi3VLt1wVMo_CtqgmVf8gQa_O9IzThx3e3Kma6vnGkp5JWCMBzG6NvRuN1umqwiSs0iYdtCEVuNbwjVQ8tR88MJ1sv5GlslmV8TIc48r4bKerud6nGHnXXWQ_DIK2yE47o_R7ov3j3I", + "version": "t" + }, + "properties": [ + "sed laborum", + "Excepteur fugiat ipsum voluptate" + ] + }, + { + "source": { + "type": "view", + "space": "zX5YAWCTzUsUtiqeI__9MYzWP6aqbBfk6A", + "externalId": "snbC_UjHDBisKLYGaAIpXi3VLt1wVMo_CtqgmVf8gQa_O9IzThx3e3Kma6vnGkp5JWCMBzG6NvRuN1umqwiSs0iYdtCEVuNbwjVQ8tR88MJ1sv5GlslmV8TIc48r4bKerud6nGHnXXWQ_DIK2yE47o_R7ov3j3I", + "version": "t" + }, + "properties": [ + "sed laborum", + "Excepteur fugiat ipsum voluptate" + ] + } + ], + "sort": [ + { + "property": [ + "ullamco laborum eiusmod sed" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "ullamco laborum eiusmod sed" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 87776696 + }, + "elit_94": { + "sources": [ + { + "source": { + "type": "view", + "space": "RsdWY", + "externalId": "ZusGca", + "version": "x" + }, + "properties": [ + "eu reprehenderit", + "sunt" + ] + }, + { + "source": { + "type": "view", + "space": "RsdWY", + "externalId": "ZusGca", + "version": "x" + }, + "properties": [ + "eu reprehenderit", + "sunt" + ] + } + ], + "sort": [ + { + "property": [ + "exercitation dolo" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "exercitation dolo" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": 48203108 + }, + "nulla30": { + "sources": [ + { + "source": { + "type": "view", + "space": "ucGUWc-blji2", + "externalId": "WJ3QqGV8gXozIxdFF76btO2IfnbEJXfJOcKuaa_RAkqL3LgLPTdyV86PXmEJmOqEmiN62aoDdEZ79DD5jNB3eU2ILesIV5datUFCUQx60LitWP2y_byUDsCcES7Gdyozn0KFsR27xT1eMct8pJqY_KqrawloWOsWGhjmCncnXKkAGPn40sobeus", + "version": "EuBsh" + }, + "properties": [ + "exercitation id Lorem dolore", + "aute Ut deserunt" + ] + }, + { + "source": { + "type": "view", + "space": "ucGUWc-blji2", + "externalId": "WJ3QqGV8gXozIxdFF76btO2IfnbEJXfJOcKuaa_RAkqL3LgLPTdyV86PXmEJmOqEmiN62aoDdEZ79DD5jNB3eU2ILesIV5datUFCUQx60LitWP2y_byUDsCcES7Gdyozn0KFsR27xT1eMct8pJqY_KqrawloWOsWGhjmCncnXKkAGPn40sobeus", + "version": "EuBsh" + }, + "properties": [ + "exercitation id Lorem dolore", + "aute Ut deserunt" + ] + } + ], + "sort": [ + { + "property": [ + "magna" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "magna" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -92426225 + }, + "ut2_0": { + "sources": [ + { + "source": { + "type": "view", + "space": "DNEG91VvuPB7bMkmxH0OtNlDGmpTn5EqdtELUT1sa", + "externalId": "l", + "version": "b" + }, + "properties": [ + "dolor", + "ea in" + ] + }, + { + "source": { + "type": "view", + "space": "DNEG91VvuPB7bMkmxH0OtNlDGmpTn5EqdtELUT1sa", + "externalId": "l", + "version": "b" + }, + "properties": [ + "dolor", + "ea in" + ] + } + ], + "sort": [ + { + "property": [ + "eu proident ex" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "eu proident ex" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -82068016 + }, + "laborum_514": { + "sources": [ + { + "source": { + "type": "view", + "space": "piF-CZYiMoTLIMwJ", + "externalId": "I", + "version": "f" + }, + "properties": [ + "nulla in", + "amet" + ] + }, + { + "source": { + "type": "view", + "space": "piF-CZYiMoTLIMwJ", + "externalId": "I", + "version": "f" + }, + "properties": [ + "nulla in", + "amet" + ] + } + ], + "sort": [ + { + "property": [ + "in minim in" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "in minim in" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -25048151 + }, + "anim_0d": { + "sources": [ + { + "source": { + "type": "view", + "space": "ynaHPmA9ipBAb2", + "externalId": "a", + "version": "h" + }, + "properties": [ + "voluptate sint deserunt cillum", + "ex ad" + ] + }, + { + "source": { + "type": "view", + "space": "ynaHPmA9ipBAb2", + "externalId": "a", + "version": "h" + }, + "properties": [ + "voluptate sint deserunt cillum", + "ex ad" + ] + } + ], + "sort": [ + { + "property": [ + "ex eiusmod" + ], + "direction": "ascending", + "nullsFirst": false + }, + { + "property": [ + "ex eiusmod" + ], + "direction": "ascending", + "nullsFirst": false + } + ], + "limit": -25409808 + } + }, + "cursors": { + "reprehenderitcd": "ipsum anim sed", + "in425": "irure Excepteur", + "minim083": "aliquip fugiat", + "minim_e1": "dolore ea aliqua aute in" + }, + "parameters": { + "id0e": "Ut nisi", + "cupidatat_249": "culpa dolore aute nulla dolor" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "magna7c1": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "est3": { + "type": "object", + "properties": { + "Duis_2": { + "type": "object", + "properties": { + "sed_d6f": { + "type": "string", + "description": "sed_d6f" + }, + "cupidatat_f": { + "type": "string", + "description": "cupidatat_f" + } + }, + "description": "Duis_2" + }, + "consequat_e": { + "type": "object", + "properties": { + "minima": { + "type": "string", + "description": "minima" + }, + "officia_0b": { + "type": "string", + "description": "officia_0b" + }, + "in736": { + "type": "string", + "description": "in736" + } + }, + "description": "consequat_e" + }, + "tempor_123": { + "type": "object", + "properties": { + "dolore7c": { + "type": "string", + "description": "dolore7c" + } + }, + "description": "tempor_123" + } + }, + "description": "est3" + }, + "ada": { + "type": "object", + "properties": { + "sed_00": { + "type": "object", + "properties": { + "minim_297": { + "type": "string", + "description": "minim_297" + } + }, + "description": "sed_00" + }, + "utbc": { + "type": "object", + "properties": { + "sed_cb9": { + "type": "string", + "description": "sed_cb9" + } + }, + "description": "utbc" + } + }, + "description": "ada" + }, + "incididunt76c": { + "type": "object", + "properties": { + "officia_4d": { + "type": "object", + "properties": { + "nostrud_7a1": { + "type": "string", + "description": "nostrud_7a1" + }, + "deserunt77": { + "type": "string", + "description": "deserunt77" + } + }, + "description": "officia_4d" + }, + "aliqua0": { + "type": "object", + "properties": { + "ipsum_74": { + "type": "string", + "description": "ipsum_74" + }, + "mollit_": { + "type": "string", + "description": "mollit_" + }, + "Excepteur_05": { + "type": "string", + "description": "Excepteur_05" + } + }, + "description": "aliqua0" + } + }, + "description": "incididunt76c" + } + }, + "description": "properties" + } + } + }, + "description": "magna7c1" + }, + "veniam62f": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "in3d7": { + "type": "object", + "properties": { + "commodob44": { + "type": "object", + "properties": { + "dolor_f4": { + "type": "string", + "description": "dolor_f4" + }, + "incididunt_": { + "type": "string", + "description": "incididunt_" + } + }, + "description": "commodob44" + } + }, + "description": "in3d7" + }, + "in_dee": { + "type": "object", + "properties": { + "culpa148": { + "type": "object", + "properties": { + "irure_89e": { + "type": "string", + "description": "irure_89e" + }, + "dolor_bd4": { + "type": "string", + "description": "dolor_bd4" + } + }, + "description": "culpa148" + }, + "aliqua20": { + "type": "object", + "properties": { + "Excepteura67": { + "type": "string", + "description": "Excepteura67" + }, + "dolore1": { + "type": "string", + "description": "dolore1" + }, + "voluptate4e": { + "type": "string", + "description": "voluptate4e" + }, + "et00e": { + "type": "string", + "description": "et00e" + }, + "id650": { + "type": "string", + "description": "id650" + } + }, + "description": "aliqua20" + }, + "proident__85": { + "type": "object", + "properties": { + "adipisicingfb": { + "type": "string", + "description": "adipisicingfb" + } + }, + "description": "proident__85" + } + }, + "description": "in_dee" + }, + "nostrud420": { + "type": "object", + "properties": { + "ea_7": { + "type": "object", + "properties": { + "culpa4": { + "type": "string", + "description": "culpa4" + } + }, + "description": "ea_7" + }, + "sit_c": { + "type": "object", + "properties": { + "ut_6": { + "type": "string", + "description": "ut_6" + }, + "officia_8": { + "type": "string", + "description": "officia_8" + } + }, + "description": "sit_c" + } + }, + "description": "nostrud420" + } + }, + "description": "properties" + } + } + }, + "description": "veniam62f" + }, + "qui_c": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "enimca": { + "type": "object", + "properties": { + "deserunte": { + "type": "object", + "properties": { + "anim_03e": { + "type": "string", + "description": "anim_03e" + } + }, + "description": "deserunte" + } + }, + "description": "enimca" + }, + "eiusmod5": { + "type": "object", + "properties": { + "in3c": { + "type": "object", + "properties": { + "ea_16": { + "type": "string", + "description": "ea_16" + }, + "Excepteur_bb": { + "type": "string", + "description": "Excepteur_bb" + }, + "dolorb": { + "type": "string", + "description": "dolorb" + } + }, + "description": "in3c" + }, + "nostrud_ef": { + "type": "object", + "properties": { + "dolor_d": { + "type": "string", + "description": "dolor_d" + }, + "dolor_5": { + "type": "string", + "description": "dolor_5" + }, + "mollit61": { + "type": "string", + "description": "mollit61" + }, + "sed_f": { + "type": "string", + "description": "sed_f" + } + }, + "description": "nostrud_ef" + } + }, + "description": "eiusmod5" + }, + "quis0d": { + "type": "object", + "properties": { + "in_9a": { + "type": "object", + "properties": { + "occaecata7": { + "type": "string", + "description": "occaecata7" + }, + "ipsum_880": { + "type": "string", + "description": "ipsum_880" + } + }, + "description": "in_9a" + } + }, + "description": "quis0d" + }, + "est_79": { + "type": "object", + "properties": { + "et_0": { + "type": "object", + "properties": { + "exercitation9": { + "type": "string", + "description": "exercitation9" + } + }, + "description": "et_0" + } + }, + "description": "est_79" + } + }, + "description": "properties" + } + } + }, + "description": "qui_c" + } + }, + "description": "items" + }, + "nextCursor": { + "type": "object", + "properties": { + "quisb3": { + "type": "string", + "description": "quisb3" + } + }, + "description": "nextCursor" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/models/instances/sync": { + "post": { + "summary": "Sync nodes or edges", + "description": "Subscribe to changes for nodes and edges in a project, matching a supplied filter. This endpoint will always return a ```NextCursor```. The sync specification mirrors the query interface, but sorting is not currently supported.", + "operationId": "SyncNodes_edges", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "with": { + "type": "object", + "minItems": 1, + "maxItems": 20, + "description": "with" + }, + "select": { + "type": "object", + "minItems": 1, + "maxItems": 20, + "description": "select" + }, + "cursors": { + "type": "object", + "maxItems": 20, + "description": "cursors" + }, + "parameters": { + "type": "object", + "description": "parameters" + } + }, + "default": { + "with": { + "non_6a6": { + "nodes": { + "from": "v", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "wtmCzul5WQsg6i", + "externalId": "uaqjkw5wiqjAe1bgnkFvdWTbsGl5vs2awM60l2jfUdT3rn8ya3lpSj47KvJS27BD3gc3N4JxQZTfXr4XpFT7SAl7jzxtFdiPm3IpCizOvkhaP9mS1eXn4Oi0AkfDbA_4CKGOWPAZUMIUnFhRYGDoMYulcUv1QDxgrVB4jQUuSEc9dFhQYafpi5cgn0sURyaXW4YlGPKppFFIrja5evOXBwWPDdwbjoKDU8zWHpOx8oN9PPiTUulc", + "version": "ypzb1gU" + }, + "identifier": "YxDulCMtAXeNvXXTrgsnGwJxbGI2MjB2wGrWTxIf" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": -76461346 + }, + "inc": { + "nodes": { + "from": "et cupidatat officia laboris", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "DzQNd_0xj6AsxN0uQgunBkwCQGKricmAP5zdgZs", + "externalId": "h", + "version": "j" + }, + "identifier": "A6kgL8y1FFq586s_7Y6TLEeXMkXbiOMRkVK6zcpWUmtn0fW6fhRem8tSRkguydTKIXmx86bKgf4A2ZmXsg9b0oU68bjaCWeKdDBfIlH91tWGKUeCRBimRkYTQ2cPWP2GvdJOZuODrv5btNmxIm_IRZlZ4G1WFBaqK20" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": 38119359 + }, + "Excepteur4e": { + "nodes": { + "from": "cupidatat laborum", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "DfuCnEZJFQe_pOyq7QckQefBtH0Ow", + "externalId": "IEy2mr63MCunhq7CwYWObsZ3N1ln9QUEoVC3TzjXJiRYwuGD86xTMYKV3dXvD8d_27Nnh26qnjejMD_MYjrV1des4HxpQ99vLB29MnMBzQKIUpaRGU99UGY675FNWxoyxsMTvKP9bNSebJrh9thQ890rSbtsxUcxfNH_MnZh4U", + "version": "g" + }, + "identifier": "O" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": -26620272 + }, + "adipisicing1": { + "nodes": { + "from": "nisi laborum quis cupidatat", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "u6ayVIFNaY3", + "externalId": "PLgLuSFQS4SbytuDqXYGUZyvvPB6e2PBfUvOUue95MKUtT5SAvv8gxHHPuPeJJEQWwofCR_TvFkAuT8uZgGbYqCZgkL2TQagX4mHYdOFGv", + "version": "v" + }, + "identifier": "E" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": 53462101 + }, + "qui_80": { + "nodes": { + "from": "dolore culpa elit labore", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "ddrT9b-Kt8tSCMrL", + "externalId": "c_DlJGYYeiGmpckw9u63gh9BuPC34RXRaquP3jJ9zHXrclwT2iGoXxzMMDkljUzXp90fyMh9a8RtYxHC_e0UpxEQkleLZsxEgL3nT0mjOcT0SgOdbjzuyI_6OxWjE5rejUHMyw6hFkhIAhixh9Iqrl1wEBuykkRv_BKsY_WZs5F_2rXFoXzsU4mIS8OFjB7hXOJ13PaRXTAYQYoM5GyBWEYTbnw3mbrXvM4aNRUGtO", + "version": "a" + }, + "identifier": "p179OVlyRwL9SKQH1qdanGVBeajpcHmaDGkrQvvdAWVyNcxPiIUalVrZ4uGHFktyKtk8tcirr6ZEy1OPT7SEgs3jt8ED31cYUqo4MNQyl9m5bRhsMR2JPBBD6laoUEvmPik2ouy7eyYBvhDNNhi_AA4AagVEzXs6LbvaClEGUSyhlNWMm4" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": 16462933 + }, + "tempor_262": { + "nodes": { + "from": "amet do ut aliqua quis", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "CH7AW77njj", + "externalId": "NUPpOF72cqGZtq9PIyJx1rvDBGuSZOs5hKvJvRV_XYCMqEAI_bONs0Vo5IVowONQzc8a23Bcz42BqMGHHLPIJeubVOAnVylS8NgqxyRGsYZcn_pVtMZ_dDvWUW8LlWTb4tVCnLsxyBIDHeY5bayqiLXFDgfG7P1Ih5jMco83AZinokBsc4N1ZSxTsrPaSZao5AqG0F47CWssaPx8", + "version": "Q" + }, + "identifier": "tXwhPvNsQO__zWIcNMHQpWl06z8xzliPbY8QO3X09miVZRbOY9O8x6h7bi7W_gfpPLKYsupzCnK5g8L4Z_BHu" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": -95377874 + }, + "dolore_": { + "nodes": { + "from": "enim", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "RdSXdUeWUCTT9Bc2cpGt", + "externalId": "V", + "version": "2" + }, + "identifier": "KkhO1WkK3BcvH_iKlO6CgZdUMG9Wi176BphG1O99WKbOM9bLzbQSX1mxr3xHG6u5ijTycIYog4IR9GA1WUFpouMj2TxE3IpUrO1sD8dEucbSrHEbGkAsm7UxnFJ52j7C_quFhXeGuXTA6ha43ZravoEu8LP6jDGv8YzQshvcYtxGMD074tzVC" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": -83551600 + }, + "labore1e": { + "nodes": { + "from": "pariatur quis", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "b7oXGh28Uq", + "externalId": "M", + "version": "33_KkeZBCXlifBzGbNPb" + }, + "identifier": "WS242HcEQtcIoahiayeZHAPr5xBC" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": -43445285 + }, + "elit_d_8": { + "nodes": { + "from": "laborum ea consectetur fugiat", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "zMfCk", + "externalId": "f", + "version": "OPHf7NmllejltjgP_IY_cgnFnRpV6fj" + }, + "identifier": "M" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": -59369822 + }, + "Excepteurb50": { + "nodes": { + "from": "veniam velit", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "YoN3uhywEDv9-Zr4x7wk95wV", + "externalId": "TtszpPNywH", + "version": "7" + }, + "identifier": "QW_wbJlt3dfLtaIk2NJR7V7YoA4R7hEjO57iRqjaYwk_PnNRJjalfwBEe3fOhZkKb6WQIJ_EbhEeskLisBEpMh6NQafaiuY3yo4Xomhx5mVWPhBXqsLc_J11jBpOvpDmV2Rb0zSoOzvp3DP8mWRLH1wQdwLLkbsypX62jcMANmkkPYpylF4HpmrzuJEzAOW6jDMYZ1b8Le" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": -99245871 + }, + "est2": { + "nodes": { + "from": "in irure id occaecat", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "bxoS1OHsWXiBhaQ8L4joJ6Io6CqcobMuMsX", + "externalId": "q", + "version": "F" + }, + "identifier": "v4CBIdX6KHiGlpvxmIxqWJaG4dokdHg" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": 86261751 + }, + "exercitation_c": { + "nodes": { + "from": "quis est", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "Q5maj0j", + "externalId": "i", + "version": "A" + }, + "identifier": "z" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": 4927553 + }, + "in6_0": { + "nodes": { + "from": "nisi commodo consequat", + "chainTo": "destination", + "through": { + "view": { + "type": "view", + "space": "NaskqREAUS7O3KZqUJn", + "externalId": "NRrIvq4kUQphuArx4qFOLAUmMFwxcBcuAQwMUo034r6gQUBi_zUL75p02lBWw2WjIcjNJXzxzzRglbFZwKqhFjxdA_iASH9rwrQ3UNHWofLBcnBFXnU8amWlHQD_GMdac0DM6R0_N_YkOvBqImini4uCvfK7Y", + "version": "4" + }, + "identifier": "CDrf1__lEecQTtvZmsrHLDPzOv5HO5tvlxqHvUO3e18XNU_Ltk4Ndzjc4lJlgcLH45wZoKSCFpohYBog1qOwpxkcVqhrfHrpN1TJOC75nVMmTNlbU2rSjMFece_vJeP9bt0eTOzuUAh3ZhU83wzKBz" + }, + "filter": { + "and": [ + { + "value": "" + } + ] + } + }, + "limit": 51243699 + } + }, + "select": { + "mollit3": { + "sources": [ + { + "source": { + "type": "view", + "space": "Ug_i26iS3oqKmX6lgbzFVDQlPa6dM7KRBnz1x", + "externalId": "XV_K4ViCSUQatBdveNOAsuLGtO32yuZMks7QASgu9BhtGN6ZxU6ksEv_JE3fnMYLVDFcf1LqCD_S8WeAJpWi3jD9FtZVOJ8iDHdMZXBg9kl1We6nSDo7Ci4mpZhx8VoNKonGbzNYL5kyf2JAhCT", + "version": "x" + }, + "properties": [ + "elit Ut", + "qui tempor" + ] + }, + { + "source": { + "type": "view", + "space": "Ug_i26iS3oqKmX6lgbzFVDQlPa6dM7KRBnz1x", + "externalId": "XV_K4ViCSUQatBdveNOAsuLGtO32yuZMks7QASgu9BhtGN6ZxU6ksEv_JE3fnMYLVDFcf1LqCD_S8WeAJpWi3jD9FtZVOJ8iDHdMZXBg9kl1We6nSDo7Ci4mpZhx8VoNKonGbzNYL5kyf2JAhCT", + "version": "x" + }, + "properties": [ + "elit Ut", + "qui tempor" + ] + } + ] + } + }, + "cursors": { + "commodo_b4": "minim ex", + "dolorea": "ipsum amet", + "ametda": "nostrud eiusmod do", + "fugiat_0af": "fugiat commodo cupidatat veniam", + "proidentc": "ut incididunt irure quis", + "elit888": "n" + }, + "parameters": { + "consectetur166": "eiusmod sint ea irure", + "sed__7": "esse" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "sunt58": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "consequata94": { + "type": "object", + "properties": { + "enim_b": { + "type": "object", + "properties": { + "aute4": { + "type": "string", + "description": "aute4" + } + }, + "description": "enim_b" + }, + "exercitation_": { + "type": "object", + "properties": { + "deseruntaa9": { + "type": "string", + "description": "deseruntaa9" + } + }, + "description": "exercitation_" + }, + "labore19": { + "type": "object", + "properties": { + "eiusmoda": { + "type": "string", + "description": "eiusmoda" + }, + "dolore579": { + "type": "string", + "description": "dolore579" + } + }, + "description": "labore19" + }, + "Duis_515": { + "type": "object", + "properties": { + "sintdf7": { + "type": "string", + "description": "sintdf7" + }, + "velit8": { + "type": "string", + "description": "velit8" + } + }, + "description": "Duis_515" + } + }, + "description": "consequata94" + }, + "ullamco_0": { + "type": "object", + "properties": { + "voluptate1": { + "type": "object", + "properties": { + "elit9e_": { + "type": "string", + "description": "elit9e_" + }, + "cillum_94": { + "type": "string", + "description": "cillum_94" + } + }, + "description": "voluptate1" + } + }, + "description": "ullamco_0" + }, + "laborum0": { + "type": "object", + "properties": { + "pariatur_c": { + "type": "object", + "properties": { + "ea7e8": { + "type": "string", + "description": "ea7e8" + }, + "incididunt_52d": { + "type": "string", + "description": "incididunt_52d" + } + }, + "description": "pariatur_c" + } + }, + "description": "laborum0" + } + }, + "description": "properties" + } + } + }, + "description": "sunt58" + }, + "consectetur3d6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "instanceType": { + "type": "string", + "description": "instanceType" + }, + "space": { + "type": "string", + "description": "space" + }, + "externalId": { + "type": "string", + "description": "externalId" + }, + "createdTime": { + "type": "integer", + "format": "int32", + "description": "createdTime" + }, + "lastUpdatedTime": { + "type": "integer", + "format": "int32", + "description": "lastUpdatedTime" + }, + "version": { + "type": "integer", + "format": "int32", + "description": "version" + }, + "deletedTime": { + "type": "integer", + "format": "int32", + "description": "deletedTime" + }, + "properties": { + "type": "object", + "properties": { + "consectetur_c": { + "type": "object", + "properties": { + "mollitb": { + "type": "object", + "properties": { + "proident_4b": { + "type": "string", + "description": "proident_4b" + }, + "et_fd8": { + "type": "string", + "description": "et_fd8" + } + }, + "description": "mollitb" + }, + "reprehenderit7": { + "type": "object", + "properties": { + "sunt_19": { + "type": "string", + "description": "sunt_19" + }, + "occaecate9": { + "type": "string", + "description": "occaecate9" + } + }, + "description": "reprehenderit7" + }, + "Excepteur_51": { + "type": "object", + "properties": { + "sit7": { + "type": "string", + "description": "sit7" + }, + "magna8_": { + "type": "string", + "description": "magna8_" + }, + "dolore0": { + "type": "string", + "description": "dolore0" + } + }, + "description": "Excepteur_51" + } + }, + "description": "consectetur_c" + }, + "anim_b": { + "type": "object", + "properties": { + "ut_86b": { + "type": "object", + "properties": { + "consectetur__a": { + "type": "string", + "description": "consectetur__a" + } + }, + "description": "ut_86b" + }, + "et_2": { + "type": "object", + "properties": { + "voluptatefcb": { + "type": "string", + "description": "voluptatefcb" + }, + "aliquipc": { + "type": "string", + "description": "aliquipc" + } + }, + "description": "et_2" + }, + "Excepteur_9c": { + "type": "object", + "properties": { + "dolore_461": { + "type": "string", + "description": "dolore_461" + }, + "qui_8c4": { + "type": "string", + "description": "qui_8c4" + } + }, + "description": "Excepteur_9c" + } + }, + "description": "anim_b" + } + }, + "description": "properties" + } + } + }, + "description": "consectetur3d6" + } + }, + "description": "items" + }, + "nextCursor": { + "type": "object", + "properties": { + "sint5": { + "type": "string", + "description": "sint5" + }, + "voluptate_380": { + "type": "string", + "description": "voluptate_380" + }, + "labore_f": { + "type": "string", + "description": "labore_f" + } + }, + "description": "nextCursor" + } + } + } + }, + "400": { + "description": "400", + "schema": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "code" + }, + "message": { + "type": "string", + "description": "message" + }, + "missing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ea5eb": { + "type": "number", + "format": "float", + "description": "ea5eb" + }, + "eiusmod5f3": { + "type": "number", + "format": "float", + "description": "eiusmod5f3" + }, + "ipsum_2b": { + "type": "number", + "format": "float", + "description": "ipsum_2b" + } + } + }, + "description": "missing" + }, + "duplicated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dolor_c8": { + "type": "number", + "format": "float", + "description": "dolor_c8" + }, + "ipsum7": { + "type": "integer", + "format": "int32", + "description": "ipsum7" + }, + "elitf5": { + "type": "integer", + "format": "int32", + "description": "elitf5" + }, + "dolored8": { + "type": "string", + "description": "dolored8" + }, + "Duis_77a": { + "type": "string", + "description": "Duis_77a" + } + } + }, + "description": "duplicated" + } + }, + "description": "error" + } + } + } + } + } + } + }, + "/api/v1/projects/{project}/userapis/spaces/{space}/datamodels/{datamodel}/versions/{version}/graphql": { + "post": { + "responses": { + "default": { + "description": "default", + "schema": {} + } + }, + "summary": "Query GraphQL", + "parameters": [ + { + "name": "project", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "Content-Type", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Content-Type", + "x-ms-visibility": "advanced" + }, + { + "name": "Accept", + "in": "header", + "required": false, + "type": "string", + "default": "application/json", + "description": "Accept", + "x-ms-visibility": "advanced" + }, + { + "name": "space", + "in": "path", + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$", + "required": true + }, + { + "name": "datamodel", + "in": "path", + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$", + "required": true + }, + { + "name": "version", + "in": "path", + "type": "string", + "minLength": 1, + "maxLength": 43, + "pattern": "^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "query" + }, + "variables": { + "type": "object", + "description": "variables" + } + } + }, + "required": true + } + ], + "description": "Query_GraphQL", + "operationId": "Query_GraphQL" + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "oauth2-auth": { + "type": "oauth2", + "flow": "accessCode", + "tokenUrl": "https://login.windows.net/common/oauth2/authorize", + "scopes": { + "https://bluefield.cognitedata.com/.default": "https://bluefield.cognitedata.com/.default" + }, + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize" + } + }, + "security": [ + { + "oauth2-auth": [ + "https://bluefield.cognitedata.com/.default" + ] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://api-docs.cognite.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://www.cognite.com/en/policy" + }, + { + "propertyName": "Categories", + "propertyValue": "Cognite Data Fusion; Industrial data" + } + ] +} \ No newline at end of file diff --git a/certified-connectors/Cognite Data Fusion/apiProperties.json b/certified-connectors/Cognite Data Fusion/apiProperties.json new file mode 100644 index 0000000000..64cab78190 --- /dev/null +++ b/certified-connectors/Cognite Data Fusion/apiProperties.json @@ -0,0 +1,36 @@ +{ + "properties": { + "capabilities": [ + "actions" + ], + "connectionParameters": { + "token": { + "type": "oAuthSetting", + "oAuthSettings": { + "identityProvider": "oauth2", + "clientId": "PLACEHOLDER_CLIENTID", + "scopes": ["https://bluefield.cognitedata.com/.default"], + "redirectMode": "Global", + "redirectUrl": "https://global.consent.azure-apim.net/redirect", + "properties": { + "IsFirstParty": "False" + }, + "customParameters": { + "authorizationUrl": { + "value": "https://login.microsoftonline.com/PLACEHOLDER_TENANTID/oauth2/v2.0/authorize" + }, + "tokenUrl": { + "value": "https://login.microsoftonline.com/PLACEHOLDER_TENANTID/oauth2/v2.0/token" + }, + "refreshUrl": { + "value": "https://login.microsoftonline.com/PLACEHOLDER_TENANTID/oauth2/v2.0/token" + } + } + } + } + }, + "iconBrandColor": "#000000", + "publisher": "Cognite AS", + "stackOwner": "Cognite AS" + } +} From 73bd3fbfd32017475f1df3dc0b855ebf4b93d417 Mon Sep 17 00:00:00 2001 From: Viet Le Date: Wed, 25 Oct 2023 13:06:16 -0500 Subject: [PATCH 02/11] add summary and description to parameters --- .../apiDefinition.swagger.json | 441 ++++++++++++++---- 1 file changed, 360 insertions(+), 81 deletions(-) diff --git a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json index 30e2f12226..095fa9c063 100644 --- a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json +++ b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json @@ -28,12 +28,16 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "limit", + "x-ms-summary": "limit", + "description": "Limits the number of results to return. CDF returns a maximum of 1000 results even if you specify a higher limit.", "default": 100, "in": "query", "type": "integer", @@ -44,6 +48,8 @@ }, { "name": "includeMetadata", + "x-ms-summary": "includeMetadata", + "description": "Whether the metadata field should be returned or not.", "default": true, "in": "query", "type": "boolean", @@ -51,32 +57,40 @@ }, { "name": "cursor", + "x-ms-summary": "cursor", + "description": "Cursor for paging through results.", "in": "query", "type": "string", "required": false }, { "name": "partition", + "x-ms-summary": "partition", + "description": "Splits the data set into N partitions. The attribute is specified as a \"M/N\" string, where M is a natural number in the interval of [1, N]. You need to follow the cursors within each partition in order to receive all the data.\nTo prevent unexpected problems and maximize read throughput, you should at most use 10 (N <= 10) partitions.\nWhen using more than 10 partitions, CDF may reduce the number of partitions silently. For example, CDF may reduce the number of partitions to K = 10 so if you specify an X/N partition value where X = 8 and N = 20 - i.e. \"partition\": \"8/20\"- then CDF will change N to N = K = 10 and process the request. But if you specify the X/N partition value where X = 11 (X > K) and N = 20 - i.e. \"partition\": \"11/20\"- then CDF will reply with an empty result list and no cursor in the response.\nIn future releases of the resource APIs, Cognite may reject requests if you specify more than 10 partitions. When Cognite enforces this behavior, the requests will result in a 400 Bad Request status.", "in": "query", "type": "string", "required": false }, { "name": "assetIds", + "x-ms-summary": "assetIds", + "description": "Gets the time series related to the assets. The format is a list of IDs serialized as a JSON array(int64). Takes [ 1 .. 100 ] unique items.", "in": "query", "type": "string", - "description": "[363848954441724, 793045462540095, 1261042166839739]", "required": false }, { "name": "rootAssetIds", + "x-ms-summary": "rootAssetIds", + "description": "Only includes time series that have a related asset in a tree rooted at any of these root assetIds.", "in": "query", "type": "string", - "description": "[363848954441724, 793045462540095, 1261042166839739]", "required": false }, { "name": "externalIdPrefix", + "x-ms-summary": "externalIdPrefix", + "description": "Filter by this (case-sensitive) prefix for the external ID.", "in": "query", "type": "string", "maxLength": 255, @@ -84,11 +98,12 @@ }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" } ], @@ -198,30 +213,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Create time series object body.", "in": "body", "schema": { "type": "object", @@ -516,30 +537,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Retrieve time series object body.", "in": "body", "schema": { "type": "object", @@ -760,30 +787,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Filter time series object body.", "in": "body", "schema": { "type": "object", @@ -1183,30 +1216,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Aggregate time series object body.", "in": "body", "schema": { "type": "object", @@ -1577,30 +1616,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Search time series object body.", "in": "body", "schema": { "type": "object", @@ -1949,30 +1994,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Update time series object body.", "in": "body", "schema": { "type": "object", @@ -2308,30 +2359,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete time series object body.", "in": "body", "schema": { "type": "object", @@ -2471,30 +2528,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Insert data points object body.", "in": "body", "schema": { "type": "object", @@ -2658,30 +2721,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Retrieve data points object body.", "in": "body", "schema": { "type": "object", @@ -2988,30 +3057,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Retrieve latest data point object body.", "in": "body", "schema": { "type": "object", @@ -3173,30 +3248,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete data points object body.", "in": "body", "schema": { "type": "object", @@ -3306,12 +3387,16 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "limit", + "x-ms-summary": "limit", + "description": "Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit.", "default": 10, "in": "query", "type": "integer", @@ -3322,12 +3407,16 @@ }, { "name": "cursor", + "x-ms-summary": "cursor", + "description": "Cursor for paging through results.", "in": "query", "type": "string", "required": false }, { "name": "includeGlobal", + "x-ms-summary": "includeGlobal", + "description": "If the global items of the entity should be returned. Defaults to false which excludes global items.", "default": false, "in": "query", "type": "boolean", @@ -3335,11 +3424,12 @@ }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" } ], @@ -3479,30 +3569,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Create or update spaces object body.", "in": "body", "schema": { "type": "object", @@ -3706,30 +3802,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Retrieve spaces by their space-ids object body.", "in": "body", "schema": { "type": "object", @@ -3898,30 +4000,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete spaces object body.", "in": "body", "schema": { "type": "object", @@ -4068,12 +4176,16 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "limit", + "x-ms-summary": "limit", + "description": "Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit.", "default": 10, "in": "query", "type": "integer", @@ -4084,12 +4196,16 @@ }, { "name": "cursor", + "x-ms-summary": "cursor", + "description": "Cursor for paging through results.", "in": "query", "type": "string", "required": false }, { "name": "inlineViews", + "x-ms-summary": "inlineViews", + "description": "Should we expand the referenced views inline in the returned result.", "default": false, "in": "query", "type": "boolean", @@ -4097,6 +4213,8 @@ }, { "name": "space", + "x-ms-summary": "space", + "description": "The space to query.", "in": "query", "type": "string", "minLength": 1, @@ -4106,6 +4224,8 @@ }, { "name": "allVersions", + "x-ms-summary": "allVersions", + "description": "If all versions of the entity should be returned. Defaults to false which returns the latest version, attributed to the newest 'createdTime' field.", "default": false, "in": "query", "type": "boolean", @@ -4113,6 +4233,8 @@ }, { "name": "includeGlobal", + "x-ms-summary": "includeGlobal", + "description": "If the global items of the entity should be returned. Defaults to false which excludes global items.", "default": false, "in": "query", "type": "boolean", @@ -4120,11 +4242,12 @@ }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" } ], @@ -4297,30 +4420,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Create or update data models object body.", "in": "body", "schema": { "type": "object", @@ -4594,6 +4723,8 @@ "parameters": [ { "name": "inlineViews", + "x-ms-summary": "inlineViews", + "description": "Should we expand the referenced views inline in the returned result.", "default": false, "in": "query", "type": "boolean", @@ -4601,30 +4732,36 @@ }, { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Retrieve data models by their external ids object body.", "in": "body", "schema": { "type": "object", @@ -4842,30 +4979,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete data models object body.", "in": "body", "schema": { "type": "object", @@ -5036,12 +5179,16 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "limit", + "x-ms-summary": "limit", + "description": "Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit.", "default": 10, "in": "query", "type": "integer", @@ -5052,12 +5199,16 @@ }, { "name": "cursor", + "x-ms-summary": "cursor", + "description": "Cursor for paging through results.", "in": "query", "type": "string", "required": false }, { "name": "space", + "x-ms-summary": "space", + "description": "The space to query.", "in": "query", "type": "string", "minLength": 1, @@ -5067,6 +5218,8 @@ }, { "name": "includeInheritedProperties", + "x-ms-summary": "includeInheritedProperties", + "description": "Include properties inherited from views this view implements.", "default": true, "in": "query", "type": "boolean", @@ -5074,6 +5227,8 @@ }, { "name": "allVersions", + "x-ms-summary": "allVersions", + "description": "If all versions of the entity should be returned. Defaults to false which returns the latest version, attributed to the newest 'createdTime' field.", "default": false, "in": "query", "type": "boolean", @@ -5081,6 +5236,8 @@ }, { "name": "includeGlobal", + "x-ms-summary": "includeGlobal", + "description": "If the global items of the entity should be returned. Defaults to false which excludes global items.", "default": false, "in": "query", "type": "boolean", @@ -5088,11 +5245,12 @@ }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" } ], @@ -5496,30 +5654,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Create or update views object body.", "in": "body", "schema": { "type": "object", @@ -6232,6 +6396,8 @@ "parameters": [ { "name": "includeInheritedProperties", + "x-ms-summary": "includeInheritedProperties", + "description": "Include properties inherited from views this view implements.", "default": true, "in": "query", "type": "boolean", @@ -6239,30 +6405,36 @@ }, { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "etrieve views by their external ids object body.", "in": "body", "schema": { "type": "object", @@ -6711,30 +6883,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete views object body.", "in": "body", "schema": { "type": "object", @@ -6905,12 +7083,16 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "limit", + "x-ms-summary": "limit", + "description": "Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit.", "default": 10, "in": "query", "type": "integer", @@ -6921,12 +7103,16 @@ }, { "name": "cursor", + "x-ms-summary": "cursor", + "description": "Cursor for paging through results.", "in": "query", "type": "string", "required": false }, { "name": "space", + "x-ms-summary": "space", + "description": "The space to query.", "in": "query", "type": "string", "minLength": 1, @@ -6936,6 +7122,8 @@ }, { "name": "includeGlobal", + "x-ms-summary": "includeGlobal", + "description": "If the global items of the entity should be returned. Defaults to false which excludes global items.", "default": false, "in": "query", "type": "boolean", @@ -6943,11 +7131,12 @@ }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" } ], @@ -7485,30 +7674,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Create or update containers object body.", "in": "body", "schema": { "type": "object", @@ -8200,30 +8395,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Retrieve containers by their external ids object body.", "in": "body", "schema": { "type": "object", @@ -8791,30 +8992,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete containers object body.", "in": "body", "schema": { "type": "object", @@ -8973,30 +9180,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete indexes from containers object body.", "in": "body", "schema": { "type": "object", @@ -9164,30 +9377,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete constraints from containers object body.", "in": "body", "schema": { "type": "object", @@ -9355,30 +9574,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Create or update nodes or edges object body.", "in": "body", "schema": { "type": "object", @@ -9613,30 +9838,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Filter nodes or edges object body.", "in": "body", "schema": { "type": "object", @@ -10467,30 +10698,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Retrieve nodes or edges by their external ids object body.", "in": "body", "schema": { "type": "object", @@ -11628,30 +11865,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Search for nodes or edges object body.", "in": "body", "schema": { "type": "object", @@ -12256,30 +12499,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Aggregate data across nodes or edges object body.", "in": "body", "schema": { "type": "object", @@ -12653,30 +12902,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Delete nodes or edges object body.", "in": "body", "schema": { "type": "object", @@ -12849,30 +13104,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Query nodes or edges object body.", "in": "body", "schema": { "type": "object", @@ -12880,18 +13141,18 @@ "with": { "type": "object", "minItems": 1, - "maxItems": 20, + "maxItems": 50, "description": "with" }, "select": { "type": "object", "minItems": 1, - "maxItems": 20, + "maxItems": 50, "description": "select" }, "cursors": { "type": "object", - "maxItems": 20, + "maxItems": 50, "description": "cursors" }, "parameters": { @@ -14493,30 +14754,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "body", + "x-ms-summary": "body", + "description": "Sync nodes or edges object body.", "in": "body", "schema": { "type": "object", @@ -14524,18 +14791,18 @@ "with": { "type": "object", "minItems": 1, - "maxItems": 20, + "maxItems": 50, "description": "with" }, "select": { "type": "object", "minItems": 1, - "maxItems": 20, + "maxItems": 50, "description": "select" }, "cursors": { "type": "object", - "maxItems": 20, + "maxItems": 50, "description": "cursors" }, "parameters": { @@ -15303,30 +15570,36 @@ "parameters": [ { "name": "project", + "x-ms-summary": "project", + "description": "The Cognite Data Fusion project.", "in": "path", "type": "string", "required": true }, { "name": "Content-Type", + "x-ms-summary": "Content Type", + "description": "Content-Type Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Content-Type", "x-ms-visibility": "advanced" }, { "name": "Accept", + "x-ms-summary": "Accept", + "description": "Accept Header MimeType", "in": "header", "required": false, "type": "string", "default": "application/json", - "description": "Accept", "x-ms-visibility": "advanced" }, { "name": "space", + "x-ms-summary": "space", + "description": "The space to query.", "in": "path", "type": "string", "minLength": 1, @@ -15336,6 +15609,8 @@ }, { "name": "datamodel", + "x-ms-summary": "datamodel", + "description": "The datamodel to query.", "in": "path", "type": "string", "minLength": 1, @@ -15345,6 +15620,8 @@ }, { "name": "version", + "x-ms-summary": "version", + "description": "Data model version (opaque string controlled by client applications)", "in": "path", "type": "string", "minLength": 1, @@ -15354,6 +15631,8 @@ }, { "name": "body", + "x-ms-summary": "body", + "description": "Query GraphQL object body.", "in": "body", "schema": { "type": "object", From 5ac5300aa899fecc37084f9d33b357f5d3a3db35 Mon Sep 17 00:00:00 2001 From: Viet Le Date: Wed, 25 Oct 2023 13:16:26 -0500 Subject: [PATCH 03/11] update apiproperties enum value --- certified-connectors/Cognite Data Fusion/apiProperties.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/certified-connectors/Cognite Data Fusion/apiProperties.json b/certified-connectors/Cognite Data Fusion/apiProperties.json index 64cab78190..3a01607e1f 100644 --- a/certified-connectors/Cognite Data Fusion/apiProperties.json +++ b/certified-connectors/Cognite Data Fusion/apiProperties.json @@ -5,7 +5,7 @@ ], "connectionParameters": { "token": { - "type": "oAuthSetting", + "type": "oauthSetting", "oAuthSettings": { "identityProvider": "oauth2", "clientId": "PLACEHOLDER_CLIENTID", From ed301fd7c624f3eeb196f70bb940a2eddd847779 Mon Sep 17 00:00:00 2001 From: Viet Le Date: Thu, 26 Oct 2023 08:31:35 -0500 Subject: [PATCH 04/11] update Categories --- .../Cognite Data Fusion/apiDefinition.swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json index 095fa9c063..8f389e62a8 100644 --- a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json +++ b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json @@ -15688,7 +15688,7 @@ }, { "propertyName": "Categories", - "propertyValue": "Cognite Data Fusion; Industrial data" + "propertyValue": "AI; Business Management; Business Intelligence; Content and Files; Data" } ] } \ No newline at end of file From e650fbbc4d57a517589c77d4d421f20f663b422e Mon Sep 17 00:00:00 2001 From: Viet Le Date: Thu, 26 Oct 2023 11:48:56 -0500 Subject: [PATCH 05/11] update Categories --- .../Cognite Data Fusion/apiDefinition.swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json index 8f389e62a8..3e3754533d 100644 --- a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json +++ b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json @@ -15688,7 +15688,7 @@ }, { "propertyName": "Categories", - "propertyValue": "AI; Business Management; Business Intelligence; Content and Files; Data" + "propertyValue": "AI; Data" } ] } \ No newline at end of file From b69cc7c8a71c65aeb656d8b1d82b14d3384723a2 Mon Sep 17 00:00:00 2001 From: Viet Le Date: Thu, 22 Feb 2024 09:15:27 -0700 Subject: [PATCH 06/11] update multi cluster --- .../Cognite Data Fusion/apiProperties.json | 168 ++++++++++++++++-- 1 file changed, 157 insertions(+), 11 deletions(-) diff --git a/certified-connectors/Cognite Data Fusion/apiProperties.json b/certified-connectors/Cognite Data Fusion/apiProperties.json index 3a01607e1f..a030f77ae5 100644 --- a/certified-connectors/Cognite Data Fusion/apiProperties.json +++ b/certified-connectors/Cognite Data Fusion/apiProperties.json @@ -5,31 +5,177 @@ ], "connectionParameters": { "token": { - "type": "oauthSetting", + "type": "oAuthSetting", "oAuthSettings": { - "identityProvider": "oauth2", + "identityProvider": "oauth2generic", "clientId": "PLACEHOLDER_CLIENTID", - "scopes": ["https://bluefield.cognitedata.com/.default"], + "scopes": ["{Scope}"], "redirectMode": "Global", - "redirectUrl": "https://global.consent.azure-apim.net/redirect", + "redirectUrl": "{RedirectUrl}", "properties": { - "IsFirstParty": "False" + "IsFirstParty": "False", + "IsOnbehalfofLoginSupported": true }, "customParameters": { - "authorizationUrl": { - "value": "https://login.microsoftonline.com/PLACEHOLDER_TENANTID/oauth2/v2.0/authorize" + "authorizationUrlTemplate": { + "value": "{AuthorizationUrl}" }, - "tokenUrl": { - "value": "https://login.microsoftonline.com/PLACEHOLDER_TENANTID/oauth2/v2.0/token" + "authorizationUrlQueryStringTemplate":{ + "value":"client_id={ClientId}&response_type=code&redirect_uri={RedirectUrl}&scope={Scope}&state={State}" }, - "refreshUrl": { - "value": "https://login.microsoftonline.com/PLACEHOLDER_TENANTID/oauth2/v2.0/token" + "tokenUrlTemplate": { + "value": "{TokenUrl}" + }, + "tokenBodyTemplate":{ + "value":"code={code}&grant_type=authorization_code&redirect_uri={RedirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" + }, + "refreshUrlTemplate": { + "value": "{RefreshUrl}" + }, + "refreshBodyTemplate":{ + "value":"code={code}&grant_type=authorization_code&redirect_uri={RedirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" } } + }, + "uiDefinition": { + "displayName": "Login", + "description": "Sign in with your Cognite Data Fusion credentials", + "tooltip": "Sign in with your Cognite Data Fusion credentials", + "constraints": { + "required": "true" + } + } + }, + "token:CDFCluster": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "displayName": "Enter your Cognite Data Fusion Cluster.", + "description": "Enter your Cognite Data Fusion Cluster.", + "tooltip": "api, greenfield, bluefield, az-eastus-1, etc..." + } + }, + "token:TenantId": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "displayName": "Enter your Tenant ID.", + "description": "Enter your Tenant ID.", + "tooltip": "Contact Cognite Support for assistance if needed." + } + }, + "token:ClientId": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "description": "Enter your Client ID.", + "displayName": "Enter your Client ID.", + "tooltip": "Contact Cognite Support for assistance if needed." + } + }, + "token:ClientSecret": { + "type": "securestring", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "description": "Enter your Client Secret.", + "displayName": "Enter your Client Secret.", + "tooltip": "Contact Cognite Support for assistance if needed." + } + }, + "token:Scope": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "displayName": "Enter your Cognite Data Fusion Scope.", + "description": "Enter your Cognite Data Fusion Scope.", + "tooltip": "https://{CDFCluster}.cognitedata.com/.default" + } + }, + "token:RedirectUrl": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "displayName": "Enter your RedirectUrl.", + "description": "Enter your RedirectUrl.", + "tooltip": "https://global.consent.azure-apim.net/redirect" + } + }, + "token:AuthorizationUrl": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "displayName": "Enter your AuthorizationUrl.", + "description": "Enter your AuthorizationUrl.", + "tooltip": "https://login.microsoftonline.com/{TenantId}/oauth2/v2.0/authorize" + } + }, + "token:TokenUrl": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "displayName": "Enter your TokenUrl.", + "description": "Enter your TokenUrl.", + "tooltip": "https://login.microsoftonline.com/{TenantId}/oauth2/v2.0/token" + } + }, + "token:RefreshUrl": { + "type": "string", + "uiDefinition": { + "constraints": { + "required": "true" + }, + "displayName": "Enter your RefreshUrl.", + "description": "Enter your RefreshUrl.", + "tooltip": "https://login.microsoftonline.com/{TenantId}/oauth2/v2.0/token" } } }, "iconBrandColor": "#000000", + "policyTemplateInstances": [ + { + "templateId": "dynamichosturl", + "title": "Set host for connection", + "parameters": { + "x-ms-apimTemplateParameter.urlTemplate": "https://@connectionParameters('token:CDFCluster').cognitedata.com" + } + }, + { + "templateId": "setheader", + "title": "Set Cognite Mixpanel x-cdp-app", + "parameters": { + "x-ms-apimTemplateParameter.name": "x-cdp-app", + "x-ms-apimTemplateParameter.value": "Cognite Power App Connector", + "x-ms-apimTemplateParameter.existsAction": "override", + "x-ms-apimTemplate-policySection": "Request" + } + }, + { + "templateId": "setheader", + "title": "Set Cognite Mixpanel x-cdp-sdk", + "parameters": { + "x-ms-apimTemplateParameter.name": "x-cdp-sdk", + "x-ms-apimTemplateParameter.value": "Cognite Power App Connector:1.0.0", + "x-ms-apimTemplateParameter.existsAction": "override", + "x-ms-apimTemplate-policySection": "Request" + } + } + ], "publisher": "Cognite AS", "stackOwner": "Cognite AS" } From 539525440a1ad7e29d111e61147e95079a389b1e Mon Sep 17 00:00:00 2001 From: Viet Le Date: Fri, 23 Feb 2024 07:17:54 -0700 Subject: [PATCH 07/11] update redirecturl tenantid --- .../Cognite Data Fusion/apiProperties.json | 32 +++++++------------ 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/certified-connectors/Cognite Data Fusion/apiProperties.json b/certified-connectors/Cognite Data Fusion/apiProperties.json index a030f77ae5..87e8eef4ca 100644 --- a/certified-connectors/Cognite Data Fusion/apiProperties.json +++ b/certified-connectors/Cognite Data Fusion/apiProperties.json @@ -5,13 +5,13 @@ ], "connectionParameters": { "token": { - "type": "oAuthSetting", + "type": "oauthSetting", "oAuthSettings": { "identityProvider": "oauth2generic", "clientId": "PLACEHOLDER_CLIENTID", "scopes": ["{Scope}"], "redirectMode": "Global", - "redirectUrl": "{RedirectUrl}", + "redirectUrl": "https://global.consent.azure-apim.net/redirect", "properties": { "IsFirstParty": "False", "IsOnbehalfofLoginSupported": true @@ -21,19 +21,19 @@ "value": "{AuthorizationUrl}" }, "authorizationUrlQueryStringTemplate":{ - "value":"client_id={ClientId}&response_type=code&redirect_uri={RedirectUrl}&scope={Scope}&state={State}" + "value":"client_id={ClientId}&response_type=code&redirect_uri={redirectUrl}&scope={Scope}&state={State}" }, "tokenUrlTemplate": { "value": "{TokenUrl}" }, "tokenBodyTemplate":{ - "value":"code={code}&grant_type=authorization_code&redirect_uri={RedirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" + "value":"code={code}&grant_type=authorization_code&redirect_uri={redirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" }, "refreshUrlTemplate": { "value": "{RefreshUrl}" }, "refreshBodyTemplate":{ - "value":"code={code}&grant_type=authorization_code&redirect_uri={RedirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" + "value":"code={code}&grant_type=authorization_code&redirect_uri={redirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" } } }, @@ -58,14 +58,17 @@ } }, "token:TenantId": { + "metadata": { + "sourceType": "AzureActiveDirectoryTenant" + }, "type": "string", "uiDefinition": { "constraints": { - "required": "true" + "hidden": "true", + "required": "false" }, - "displayName": "Enter your Tenant ID.", - "description": "Enter your Tenant ID.", - "tooltip": "Contact Cognite Support for assistance if needed." + "description": "The tenant ID of for the Azure Active Directory application", + "displayName": "Tenant" } }, "token:ClientId": { @@ -101,17 +104,6 @@ "tooltip": "https://{CDFCluster}.cognitedata.com/.default" } }, - "token:RedirectUrl": { - "type": "string", - "uiDefinition": { - "constraints": { - "required": "true" - }, - "displayName": "Enter your RedirectUrl.", - "description": "Enter your RedirectUrl.", - "tooltip": "https://global.consent.azure-apim.net/redirect" - } - }, "token:AuthorizationUrl": { "type": "string", "uiDefinition": { From bc9ec909b7eecd9f0900870011012365c7f59f95 Mon Sep 17 00:00:00 2001 From: Viet Le Date: Mon, 26 Feb 2024 12:38:30 -0600 Subject: [PATCH 08/11] changes per feedback --- .../Cognite Data Fusion/apiProperties.json | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/certified-connectors/Cognite Data Fusion/apiProperties.json b/certified-connectors/Cognite Data Fusion/apiProperties.json index 87e8eef4ca..0b4dbbe1c5 100644 --- a/certified-connectors/Cognite Data Fusion/apiProperties.json +++ b/certified-connectors/Cognite Data Fusion/apiProperties.json @@ -10,8 +10,7 @@ "identityProvider": "oauth2generic", "clientId": "PLACEHOLDER_CLIENTID", "scopes": ["{Scope}"], - "redirectMode": "Global", - "redirectUrl": "https://global.consent.azure-apim.net/redirect", + "redirectMode": "GlobalPerConnector", "properties": { "IsFirstParty": "False", "IsOnbehalfofLoginSupported": true @@ -21,19 +20,19 @@ "value": "{AuthorizationUrl}" }, "authorizationUrlQueryStringTemplate":{ - "value":"client_id={ClientId}&response_type=code&redirect_uri={redirectUrl}&scope={Scope}&state={State}" + "value":"client_id={ClientId}&response_type=code&scope={Scope}&state={State}" }, "tokenUrlTemplate": { "value": "{TokenUrl}" }, "tokenBodyTemplate":{ - "value":"code={code}&grant_type=authorization_code&redirect_uri={redirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" + "value":"code={code}&grant_type=authorization_code&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" }, "refreshUrlTemplate": { "value": "{RefreshUrl}" }, "refreshBodyTemplate":{ - "value":"code={code}&grant_type=authorization_code&redirect_uri={redirectUrl}&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" + "value":"code={code}&grant_type=authorization_code&client_id={ClientId}&client_secret={ClientSecret}&scope={Scope}" } } }, From d9086518f391ebe2b4f0fe9e6d50655a7ab746eb Mon Sep 17 00:00:00 2001 From: Viet Le Date: Mon, 26 Feb 2024 12:49:03 -0600 Subject: [PATCH 09/11] remove security definitions from swagger --- .../apiDefinition.swagger.json | 20 ++----------------- 1 file changed, 2 insertions(+), 18 deletions(-) diff --git a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json index 3e3754533d..25127208e9 100644 --- a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json +++ b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json @@ -15658,24 +15658,8 @@ "definitions": {}, "parameters": {}, "responses": {}, - "securityDefinitions": { - "oauth2-auth": { - "type": "oauth2", - "flow": "accessCode", - "tokenUrl": "https://login.windows.net/common/oauth2/authorize", - "scopes": { - "https://bluefield.cognitedata.com/.default": "https://bluefield.cognitedata.com/.default" - }, - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize" - } - }, - "security": [ - { - "oauth2-auth": [ - "https://bluefield.cognitedata.com/.default" - ] - } - ], + "securityDefinitions": {}, + "security": [], "tags": [], "x-ms-connector-metadata": [ { From 2f62c410e577e3f5a0eb1ed828ba1eada07a5e5f Mon Sep 17 00:00:00 2001 From: Viet Le Date: Mon, 26 Feb 2024 12:49:38 -0600 Subject: [PATCH 10/11] remove bluefield from swagger --- .../Cognite Data Fusion/apiDefinition.swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json index 25127208e9..0224ec61a8 100644 --- a/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json +++ b/certified-connectors/Cognite Data Fusion/apiDefinition.swagger.json @@ -10,7 +10,7 @@ "email": "support@cognite.com" } }, - "host": "bluefield.cognitedata.com", + "host": "api.cognitedata.com", "basePath": "/", "schemes": [ "https" From 21b76a17499bc769cb3e74ddb46d7be589cdac31 Mon Sep 17 00:00:00 2001 From: Viet Le Date: Thu, 29 Feb 2024 09:02:00 -1000 Subject: [PATCH 11/11] remove displayName and description from TenantId --- certified-connectors/Cognite Data Fusion/apiProperties.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/certified-connectors/Cognite Data Fusion/apiProperties.json b/certified-connectors/Cognite Data Fusion/apiProperties.json index 0b4dbbe1c5..4913831092 100644 --- a/certified-connectors/Cognite Data Fusion/apiProperties.json +++ b/certified-connectors/Cognite Data Fusion/apiProperties.json @@ -65,9 +65,7 @@ "constraints": { "hidden": "true", "required": "false" - }, - "description": "The tenant ID of for the Azure Active Directory application", - "displayName": "Tenant" + } } }, "token:ClientId": {