Sitecore CDP connections data model REST API

Abstract

Provides attributes for using Sitecore CDP connections for REST API (Data model 2.1).

The connections REST API enables you to connect Sitecore CDP to external services.

Use the following attributes for connections:

Attribute

Description

Type

Example(s)

items

The array of connections.

JSON array of JSON objects

N/A

name

The name of the connection.

string

"Connect to Data System"

description

The connection description.

string

"custom connection to weather system"

modifiedByUserRef

The unique reference of the user who modified the connection.

string

"843c775e-db9c-49f6-9f56-e3999123bcf4"

revision

The sequential number of the connection revision.

integer

2

archived

The archive status of the connection.

boolean

true, false

auth

An array of authentication attributes to connect to the service.

JSON array of JSON objects

N/A

authType

The authentication type required to authenticate requests to the external model.

string

"oauth"

clientId

The secret client ID required to connect to the external model.

string

"secretclientid"

accessTokenUrl

The URL of the access token generated by the external model. The access token URL must use an https:// URL.

string

"https://mockserver-proxy-dev.boxever.com/oauth/token"

request

A JSON array of request attributes to connect to the service.

JSON array of strings

N/A

requestType

The method type of the request.

string

"GET"

connectionUrl

The URL of the connection.

string

"https://mockserver-proxy-dev.boxever.com/sample/get/oauth"

inputMappings

An array of input mappings to define the input to the web service.

JSON array of JSON objects

N/A

outputMappings

An array of output mappings to define the output from the web service.

JSON array of JSON objects

N/A

customHeaders

A JSON array of custom headers to pass to the connection.

JSON array of JSON objects

N/A

systemType

The type of system you are connecting.

string

"DATA_SYSTEM"

connectionTimeout

The number of milliseconds that must lapse before the connection times out.

integer

1000

socketTimeout

The number of milliseconds that must lapse before the socket times out while waiting for individual packets.

integer

1000

icon

The path to the image file that contains the icon representing the connection in the UI.

string

"assets/images/icons/connections/plug.svg"