{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Function calls API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Function calls",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Call a function asynchronously",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/functions/:functionId/call",
            "params": [
              {
                "name": "functionId",
                "value": "",
                "type": "path",
                "description": "The function id."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `functionsAcl:RUN`\n\nPerform a function call. To provide input data to the function, add the data in an object called `data` in the request body. It will be available as the `data` argument into the function. Info about the function call at runtime can be obtained through the `function_call_info` argument if added in the function handle. **WARNING:** Secrets or other confidential information should not be passed via the `data` object. There is a dedicated `secrets` "
        },
        {
          "info": {
            "name": "List function calls",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/functions/:functionId/calls",
            "params": [
              {
                "name": "functionId",
                "value": "",
                "type": "path",
                "description": "The function id."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the number of results to be returned."
              },
              {
                "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:** `functionsAcl:READ`\n\nList function calls."
        },
        {
          "info": {
            "name": "Retrieve calls",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/functions/:functionId/calls/byids",
            "params": [
              {
                "name": "functionId",
                "value": "",
                "type": "path",
                "description": "The function id."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls by call ids."
        },
        {
          "info": {
            "name": "Retrieve a function call by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/functions/:functionId/calls/:callId",
            "params": [
              {
                "name": "callId",
                "value": "",
                "type": "path",
                "description": "The function call id."
              },
              {
                "name": "functionId",
                "value": "",
                "type": "path",
                "description": "The function id."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls."
        },
        {
          "info": {
            "name": "Retrieve logs for function call",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/functions/:functionId/calls/:callId/logs",
            "params": [
              {
                "name": "callId",
                "value": "",
                "type": "path",
                "description": "The function call id."
              },
              {
                "name": "functionId",
                "value": "",
                "type": "path",
                "description": "The function id."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet logs from a function call."
        },
        {
          "info": {
            "name": "Retrieve response for function call",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/functions/:functionId/calls/:callId/response",
            "params": [
              {
                "name": "callId",
                "value": "",
                "type": "path",
                "description": "The function call id."
              },
              {
                "name": "functionId",
                "value": "",
                "type": "path",
                "description": "The function id."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve response from a function call."
        },
        {
          "info": {
            "name": "Filter function calls",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/functions/:functionId/calls/list",
            "params": [
              {
                "name": "functionId",
                "value": "",
                "type": "path",
                "description": "The function id."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use advanced filtering options to find function calls."
        }
      ]
    }
  ],
  "bundled": true
}