{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Jobs API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit."
              },
              {
                "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": "source",
                "value": "",
                "type": "query",
                "description": "External ID of source the returned jobs must be tied to."
              },
              {
                "name": "destination",
                "value": "",
                "type": "query",
                "description": "External ID of destination the returned jobs must be tied to."
              },
              {
                "name": "mapping",
                "value": "",
                "type": "query",
                "description": "External ID of mapping the returned jobs must be tied to."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList all jobs in a given project. If more than `limit` jobs exist, a cursor for pagination will be returned with the response."
        },
        {
          "info": {
            "name": "Create Jobs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `hostedExtractors:READ` `hostedExtractors:WRITE`\n\nCreate up to 10 jobs."
        },
        {
          "info": {
            "name": "Retrieve Jobs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/byIds",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 jobs by their external ID, optionally ignoring unknown IDs."
        },
        {
          "info": {
            "name": "Delete Jobs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of jobs by their external ID."
        },
        {
          "info": {
            "name": "Get Job Logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/logs",
            "params": [
              {
                "name": "job",
                "value": "",
                "type": "query",
                "description": "Require returned logs to belong to the job given by this external ID."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit."
              },
              {
                "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": "source",
                "value": "",
                "type": "query",
                "description": "Require returned logs to belong to the any job with source given by this external ID."
              },
              {
                "name": "destination",
                "value": "",
                "type": "query",
                "description": "Require returned logs to belong to the any job with destination given by this external ID."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList logs, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order."
        },
        {
          "info": {
            "name": "Get Job Metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/metrics",
            "params": [
              {
                "name": "job",
                "value": "",
                "type": "query",
                "description": "Require returned metrics to belong to the job given by this external ID."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit."
              },
              {
                "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": "source",
                "value": "",
                "type": "query",
                "description": "Require returned metrics to belong to the any job with source given by this external ID."
              },
              {
                "name": "destination",
                "value": "",
                "type": "query",
                "description": "Require returned metrics to belong to the any job with destination given by this external ID."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList metrics, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order."
        },
        {
          "info": {
            "name": "Update Jobs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate a list of up to 100 jobs."
        }
      ]
    }
  ],
  "bundled": true
}