{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Schema API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Schema",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the schema of a sequence",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schema/sequence_rows",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "query",
                "description": "External ID of the Sequence"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `transformationsAcl:READ`\n"
        },
        {
          "info": {
            "name": "Get Instance schema.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schema/instances",
            "params": [
              {
                "name": "conflictMode",
                "value": "",
                "type": "query",
                "description": "conflict mode of the transformation.\n One of the following conflictMode types can be provided:\n `upsert`, `delete`\n "
              },
              {
                "name": "viewSpace",
                "value": "",
                "type": "query",
                "description": "Space of the View. Not required if `isConnectionDefinition` is true. Relevant for View centric schema."
              },
              {
                "name": "viewExternalId",
                "value": "",
                "type": "query",
                "description": "External id of the View. Not required if `isConnectionDefinition` is true. Relevant for View centric schema."
              },
              {
                "name": "viewVersion",
                "value": "",
                "type": "query",
                "description": "Version of the View. Not required if `isConnectionDefinition` is true. Relevant for View centric schema."
              },
              {
                "name": "instanceType",
                "value": "",
                "type": "query",
                "description": "Instance type to deal with"
              },
              {
                "name": "withInstanceSpace",
                "value": "",
                "type": "query",
                "description": "Is instance space set at the transformation config or not"
              },
              {
                "name": "isConnectionDefinition",
                "value": "",
                "type": "query",
                "description": "If the edge is a connection definition or not"
              },
              {
                "name": "dataModelSpace",
                "value": "",
                "type": "query",
                "description": "Space of the Data Model. Relevant for Data Model centric schema."
              },
              {
                "name": "dataModelExternalId",
                "value": "",
                "type": "query",
                "description": "External id of the Data Model. Relevant for Data Model centric schema."
              },
              {
                "name": "dataModelVersion",
                "value": "",
                "type": "query",
                "description": "Version of the Data Model. Relevant for Data Model centric schema."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "External id of the View in the Data model. Relevant for Data Model centric schema."
              },
              {
                "name": "relationshipFromType",
                "value": "",
                "type": "query",
                "description": "Property Identifier of Connection Definition in `type`. Relevant for Data Model centric schema."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nFor View centric schema, `viewSpace`, `viewExternalId`, `viewVersion` need to be specified while `withInstanceSpace`, `isConnectionDefinition`, `instanceType` are optional . For Data Model centric schema, `dataModelSpace`, `dataModelExternalId`, `dataModelVersion`, `type` need to be specified and `relationshipFromType` is optional. For Both scenarios `conflictMode` is required."
        },
        {
          "info": {
            "name": "Get the schema of resource type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schema/:schemaType",
            "params": [
              {
                "name": "schemaType",
                "value": "",
                "type": "path",
                "description": "Name of the target schema type, please provide one of the following:\n `assets`, `timeseries`, `asset_hierarchy`, `events`, `datapoints`\n `string_datapoints`, `sequences`, `files`, `labels`,\n `relationships`, `raw`, `data_sets`"
              },
              {
                "name": "conflictMode",
                "value": "",
                "type": "query",
                "description": "One of the following conflictMode types can be provided:\n `abort`, `upsert`, `update`, `delete`"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `transformationsAcl:READ`\n"
        }
      ]
    }
  ],
  "bundled": true
}