Skip to main content
POST
/
writeback
/
sap
/
requests
/
byids
Retrieve Writeback Requests
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/writeback/sap/requests/byids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "requestId": "<string>"
    }
  ],
  "ignoreUnknownIds": true
}
'
import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/writeback/sap/requests/byids"

payload = {
"items": [{ "requestId": "<string>" }],
"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: [{requestId: '<string>'}], ignoreUnknownIds: true})
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/writeback/sap/requests/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}/writeback/sap/requests/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' => [
[
'requestId' => '<string>'
]
],
'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}/writeback/sap/requests/byids"

payload := strings.NewReader("{\n \"items\": [\n {\n \"requestId\": \"<string>\"\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}/writeback/sap/requests/byids")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"requestId\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/writeback/sap/requests/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 \"requestId\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": true\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "requestId": "<string>",
      "request": [
        {
          "payload": {},
          "key": "<string>",
          "sapObjectId": "<string>"
        }
      ],
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "errorMessage": "<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.

Body

application/json

List of external IDs of writeback requests to retrieve.

items
WritebackExternalIdWrapper · object[]
required
Required array length: 1 - 100 elements
ignoreUnknownIds
boolean

Ignore IDs and external IDs that are not found

Response

List of retrieved writeback requests.

items
Request Full · object[]
required
Maximum array length: 100
Last modified on July 10, 2026