{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Workflow triggers API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workflow triggers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List triggers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/triggers",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList all triggers. The results are sorted by `externalId` in ascending order."
        },
        {
          "info": {
            "name": "Create or update triggers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/triggers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a trigger."
        },
        {
          "info": {
            "name": "Delete triggers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/triggers/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete a trigger."
        },
        {
          "info": {
            "name": "Get the run history of a trigger",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/triggers/:triggerExternalId/history",
            "params": [
              {
                "name": "triggerExternalId",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nGet information about every run of a trigger. This includes timing information and a reference to the started execution (or an explanation as to why it failed). The returned items are sorted by `fireTime` in descending order (newest first), followed by `externalId` in ascending order."
        },
        {
          "info": {
            "name": "Pause a trigger",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/triggers/:triggerExternalId/pause",
            "params": [
              {
                "name": "triggerExternalId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nPauses a trigger. When paused, the trigger will not fire until it is resumed. Note: For data modeling and records stream triggers, processing continues where the last trigger run left off at pause time, not necessarily starting again on the freshest data. The cursor can become invalid if paused too long (stream retention applies)."
        },
        {
          "info": {
            "name": "Resume a trigger",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/triggers/:triggerExternalId/resume",
            "params": [
              {
                "name": "triggerExternalId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nResumes a trigger. Once resumed, the trigger will fire according to its configuration. Note: For data modelling and records stream triggers, processing continues where the last trigger run left off at pause time, not necessarily starting again on the freshest data. The cursor can become invalid if paused too long (stream retention applies)."
        }
      ]
    }
  ],
  "bundled": true
}