How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Schema Mappings API

A **mapping** uses field and value mapping(s) to perform an in-flight transformation from source CDF entities to SAP S/4HANA entities. Mappings are written in the Cognite transformation language. For more details see the [documentation](https://docs.cognite.com/cdf/integration/guides/extraction/hosted_extractors/hosted_extractors_custom_mappings).

Cognite Schema Mappings API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Schema Mappings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

4 operations 3 paths 20 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Schema Mappings API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — 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 acce…
  • oauth2-client-credentials — 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 acce…
  • oauth2-auth-code — 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 acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Schema Mappings 4

A mapping uses field and value mapping(s) to perform an in-flight transformation from source CDF entities to SAP S/4HANA entities. Mappings are written in the Cognite transformati…

GET
/writeback/sap/mappings
List Mappings
list_schema_mappings 2 params → 200400422
POST
/writeback/sap/mappings
Create Mappings
create_schema_mappings body → 200400422
POST
/writeback/sap/mappings/byids
Retrieve Mappings
retrieve_schema_mappings 1 param body → 200400422
POST
/writeback/sap/mappings/delete
Delete Mappings
delete_schema_mappings body → 200400422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Mapping (6 properties), Error (4 properties), SchemaMapping (4 properties), CsvConfig (3 properties). Each schema is shown below with its type and property counts.

CreateSchemaMapping
object
2 properties 2 required
ProtoFile
object
Description of a protobuf file used for loading input to the mapping.
1 property 1 required
ProtobufConfig
object
List of protobuf files used to define input to the mapping. This will be compiled to a collection of definitions which will be used to convert the input to JSO…
3 properties 3 required
WritebackValidationErrorContent
object
Cognite API error.
2 properties 2 required
JsonConfig
object
Treat the input as UTF-8 encoded JSON.
1 property 1 required
WritebackItemsWithIgnoreUnknownIds_ExternalId_
object
2 properties 1 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
InputConfig
object
Optionally set input mapping input type. This defaults to json if left out. Any input type is converted to JSON before being passed to the mapping expression.
SchemaMapping
object
4 properties 4 required
Mapping
object
6 properties 6 required
Items_Mapping_
object
1 property 1 required
Items_CreateSchemaMapping_
object
1 property 1 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
Items_SchemaMapping_
object
1 property 1 required
CsvConfig
object
Transform the input from a CSV (Comma Separated Values) file to a list of JSON objects. The input to the mapping will be a list on the form [{\"header1\": \"va…
3 properties 1 required
CustomMapping
object
1 property 1 required
ItemsWithCursor_SchemaMapping_
object
2 properties 1 required
Error
object
Cognite API error.
4 properties 2 required
XmlConfig
object
Transform the input from an XML file to a JSON object.
1 property 1 required
WritebackExternalIdWrapper
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-schema-mappings-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Schema Mappings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.