/data_connections

post

https://localhost:8080/v1/data_connections

Creates a new data connection according to the defined body parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length between 3 and 60

User-defined name for the object.

friendly-name

string

length between 0 and 60

User-defined friendly-name for the object.

description

string

length between 1 and 300

User-defined description about the object.

type-id

integer

required

0 to 9223372036854776000

Defines the identifier representing the data connection type.

availability

string

enum

required

Defines the module in which the data connection will be available.

Allowed:

role

string

enum

required

Defines the role the data connection will work as.

Allowed:

permission-ids

array of integers

Defines one or more permissions identifier to associate with the data connection.

permission-ids

labels

array of strings

Defines the data connection labels defined by the user to organize the associated objects.

labels

settings

object

required

Crucial information about the object.

Headers

Retrieve-Log-Id

string

Defines whether the log identifier created by the request will be returned in the response header.

Authorization

string

required

Defines the user authorization API key.

Content-Type

string

enum

required

Defines the media type to return the content.

Allowed:

Idempotency-Key

string

Defines the idempotency-key for the request.

Cache-Only

string

enum

Identifies during operation if retrieves object from remote or local cache.

Allowed:

Response

200The data connection was created successfully.