Get Job DLQ Messages - Cognite Docs

GET

hostedextractors

jobs

dlq

Get Job DLQ Messages

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq', 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}/hostedextractors/jobs/dlq",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "items": [
    {
      "key": "<string>",
      "columns": {
        "timestamp": "<string>",
        "jobId": 123,
        "error": "<string>",
        "errorCategory": "<string>",
        "mappingExternalId": "<string>",
        "rawPayload": "<string>",
        "decodedPayload": "<string>",
        "metadata": "<string>"
      }
    }
  ],
  "nextCursor": "<string>"
}

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

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

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.

Query Parameters

job

string

required

External ID of the job to return DLQ messages for.

limit

integer

default:100

Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.

Required range: 1 <= x <= 1000

cursor

string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

minLastUpdatedTime

integer<int64>

Only return messages last updated at or after this time, in milliseconds since epoch. Must not be greater than maxLastUpdatedTime. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

maxLastUpdatedTime

integer<int64>

Only return messages last updated at or before this time, in milliseconds since epoch. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

Response

List of retrieved DLQ messages and an optional cursor.

items

DlqMessage · object[]

required

Show child attributes

nextCursor

string

Cursor for pagination, present only when more messages exist.

⌘I

Get Job DLQ Messages

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq', 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}/hostedextractors/jobs/dlq",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs/dlq")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "items": [
    {
      "key": "<string>",
      "columns": {
        "timestamp": "<string>",
        "jobId": 123,
        "error": "<string>",
        "errorCategory": "<string>",
        "mappingExternalId": "<string>",
        "rawPayload": "<string>",
        "decodedPayload": "<string>",
        "metadata": "<string>"
      }
    }
  ],
  "nextCursor": "<string>"
}

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

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