/data_connections/{id}

patch

https://localhost:8080/v1/data_connections/{id}

Updates a specific data connection by the identifier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Defines the data connection identifier.

Body Params

friendly-name

string

length between 0 and 60

User-defined friendly name for the object.

description

string

length between 0 and 300

User-defined description about the object

type-id

integer

1 to 9223372036854776000

Defines the identifier representing the data connection type.

availability

string

enum

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

Allowed:

status

string

Defines the data connection status.

role

string

enum

Defines the role the data connection will work as.

Allowed:

labels

array of strings

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

labels

last-connection

date-time

Defines the timestamp of the last connection to the source.

connection-status

string

enum

length between 0 and 60

Defines the data connection status.

Allowed:

settings

object

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

204

The data connection was updated successfully.