Sync signals - Cognite Docs

POST

processes

signals

sync

Sync signals

curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sink": {
    "type": "email",
    "externalId": "my.known.id"
  },
  "cursor": "<string>",
  "limit": 100
}
'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync"

payload = {
    "sink": {
        "type": "email",
        "externalId": "my.known.id"
    },
    "cursor": "<string>",
    "limit": 100
}
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({
    sink: {type: 'email', externalId: 'my.known.id'},
    cursor: '<string>',
    limit: 100
  })
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync', 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}/processes/signals/sync",
  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([
    'sink' => [
        'type' => 'email',
        'externalId' => 'my.known.id'
    ],
    'cursor' => '<string>',
    'limit' => 100
  ]),
  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}/processes/signals/sync"

	payload := strings.NewReader("{\n  \"sink\": {\n    \"type\": \"email\",\n    \"externalId\": \"my.known.id\"\n  },\n  \"cursor\": \"<string>\",\n  \"limit\": 100\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}/processes/signals/sync")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sink\": {\n    \"type\": \"email\",\n    \"externalId\": \"my.known.id\"\n  },\n  \"cursor\": \"<string>\",\n  \"limit\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync")

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  \"sink\": {\n    \"type\": \"email\",\n    \"externalId\": \"my.known.id\"\n  },\n  \"cursor\": \"<string>\",\n  \"limit\": 100\n}"

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

{
  "items": [
    {
      "topic": "cognite_integrations",
      "sink": {
        "type": "email",
        "externalId": "my.known.id"
      },
      "externalId": "my.known.id",
      "severity": "info",
      "resourceId": "<string>",
      "category": "<string>",
      "metadata": {
        "extractorExternalId": "<string>",
        "extractorVersion": "<string>",
        "taskName": "<string>",
        "startTime": 1730204346000,
        "endTime": 1730204346000
      },
      "message": "<string>",
      "details": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "moreData": true
}

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

{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Scopes

https://{cluster}.cognitedata.com/.default

oidc-token

https://{cluster}.cognitedata.com/.default

oauth2-client-credentials

https://api.cognitedata.com/.default

oauth2-open-industrial-data

https://{cluster}.cognitedata.com/.default

oauth2-auth-code

Headers

cdf-version

string

cdf version header. Use this to specify the requested CDF release.

Example:

"alpha"

Body

application/json

Sync request for signals.

Request for syncing signals for a sink.

sink

EmailSinkId · object

required

Reference to a sink. If the type is "user", the user must exist in the user profiles API.

EmailSinkId
UserSinkId
CurrentUserSinkId

Show child attributes

cursor

string

Cursor returned by a previous sync request. Omit to start syncing from the beginning. Unlike list cursors, sync cursors are persistent and may be stored and reused later.

limit

integer

default:100

Maximum number of signals to return.

Required range: 1 <= x <= 1000

Response

A list of signals, a cursor for the next sync, and a flag indicating whether more data is available.

List of signals with a persistent cursor for the next sync.

items

SignalRead · object[]

required

Maximum array length: 1000

Show child attributes

nextCursor

string

required

Cursor to use in the next sync request. Always present.

moreData

boolean

required

Whether more signals are immediately available. If true, another sync request with the returned cursor will return more results right away.

⌘I

Sync signals

curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sink": {
    "type": "email",
    "externalId": "my.known.id"
  },
  "cursor": "<string>",
  "limit": 100
}
'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync"

payload = {
    "sink": {
        "type": "email",
        "externalId": "my.known.id"
    },
    "cursor": "<string>",
    "limit": 100
}
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({
    sink: {type: 'email', externalId: 'my.known.id'},
    cursor: '<string>',
    limit: 100
  })
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync', 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}/processes/signals/sync",
  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([
    'sink' => [
        'type' => 'email',
        'externalId' => 'my.known.id'
    ],
    'cursor' => '<string>',
    'limit' => 100
  ]),
  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}/processes/signals/sync"

	payload := strings.NewReader("{\n  \"sink\": {\n    \"type\": \"email\",\n    \"externalId\": \"my.known.id\"\n  },\n  \"cursor\": \"<string>\",\n  \"limit\": 100\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}/processes/signals/sync")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sink\": {\n    \"type\": \"email\",\n    \"externalId\": \"my.known.id\"\n  },\n  \"cursor\": \"<string>\",\n  \"limit\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sync")

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  \"sink\": {\n    \"type\": \"email\",\n    \"externalId\": \"my.known.id\"\n  },\n  \"cursor\": \"<string>\",\n  \"limit\": 100\n}"

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

{
  "items": [
    {
      "topic": "cognite_integrations",
      "sink": {
        "type": "email",
        "externalId": "my.known.id"
      },
      "externalId": "my.known.id",
      "severity": "info",
      "resourceId": "<string>",
      "category": "<string>",
      "metadata": {
        "extractorExternalId": "<string>",
        "extractorVersion": "<string>",
        "taskName": "<string>",
        "startTime": 1730204346000,
        "endTime": 1730204346000
      },
      "message": "<string>",
      "details": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "moreData": true
}

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

{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}