{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Diagrams API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Diagrams",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List diagrams",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams",
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for paging through results. In general, if a response contains a `nextCursor`\nproperty, it means that there may be more results, and you should pass that value as the\n`cursor` parameter in the next request.\n\nNote that the cursor may or may not be encrypted, but either way, it is not intended to be\ndecoded. Its internal structure is not a part of the public API, and may change without\nnotice. You should treat it as an opaque string and not attempt to craft your own cursors.\n"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all diagrams defined in the current project."
        },
        {
          "info": {
            "name": "Retrieve diagrams",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/byids",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 diagrams by specifying their external IDs."
        },
        {
          "info": {
            "name": "Filter diagrams",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/list",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nFilter and retrieve up to 100 diagrams by specifying their properties."
        },
        {
          "info": {
            "name": "Get an extended diagram by external id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/:diagramId",
            "params": [
              {
                "name": "diagramId",
                "value": "",
                "type": "path",
                "description": "External ID of a diagram"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet diagram information and its parsed outputs using the diagram ID. The parsed output includes all diagram entities and their connections extracted during the file parsing process."
        },
        {
          "info": {
            "name": "Get an extended diagram by file reference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/:fileSpace/:fileExternalId/:pageNumber",
            "params": [
              {
                "name": "fileSpace",
                "value": "",
                "type": "path",
                "description": "A DMS space where the files reside"
              },
              {
                "name": "fileExternalId",
                "value": "",
                "type": "path",
                "description": "Retrieve data related to a file"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "path",
                "description": "The file's page number"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet diagram information and its parsed outputs using its related fileId and pageNumber. The parsed output includes all diagram entities and their connections extracted during the file parsing process."
        },
        {
          "info": {
            "name": "Get an extended diagram with paths by external id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/:diagramId/with-paths",
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for paging through results. In general, if a response contains a `nextCursor`\nproperty, it means that there may be more results, and you should pass that value as the\n`cursor` parameter in the next request.\n\nNote that the cursor may or may not be encrypted, but either way, it is not intended to be\ndecoded. Its internal structure is not a part of the public API, and may change without\nnotice. You should treat it as an opaque string and not attempt to craft your own cursors.\n"
              },
              {
                "name": "diagramId",
                "value": "",
                "type": "path",
                "description": "External ID of a diagram"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet a single diagram containing entities, connections, and SVG data by using its external id"
        }
      ]
    }
  ],
  "bundled": true
}