Skip to main content
POST
/
writeback
/
sap
/
instances
/
byids
Retrieve SAP Instances
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/writeback/sap/instances/byids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "externalId": "my.known.id"
    }
  ],
  "ignoreUnknownIds": true
}
'
{
  "items": [
    {
      "externalId": "my.known.id",
      "gatewayUrl": "<string>",
      "client": 123,
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "username": "<string>"
    }
  ]
}

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 SAP instances 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 instances.

items
Instance · object[]
required
Maximum array length: 100
Last modified on April 23, 2026