Retrieve Actions

curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/actions/byids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "externalId": "my.known.id"
    }
  ],
  "ignoreUnknownIds": true
}
'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/actions/byids"

payload = {
    "items": [{ "externalId": "my.known.id" }],
    "ignoreUnknownIds": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({items: [{externalId: 'my.known.id'}], ignoreUnknownIds: true})
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/actions/byids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/actions/byids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'externalId' => 'my.known.id'
        ]
    ],
    'ignoreUnknownIds' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/actions/byids"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"externalId\": \"my.known.id\"\n    }\n  ],\n  \"ignoreUnknownIds\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/actions/byids")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"externalId\": \"my.known.id\"\n    }\n  ],\n  \"ignoreUnknownIds\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/actions/byids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"externalId\": \"my.known.id\"\n    }\n  ],\n  \"ignoreUnknownIds\": true\n}"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "externalId": "my.integrations.id",
      "actionName": "<string>",
      "status": "pending",
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "callMetadata": {},
      "resultMessage": "<string>",
      "resultMetadata": {}
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": "`null` values aren't allowed."
  }
}

{
  "error": {
    "code": 422,
    "message": "Extra inputs are not permitted: type"
  }
}