/data_connections/{id}

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

Updates a specific data connection by the identifier.

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

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

status

string

Defines the data connection status.

role

string

Defines the role the data connection will work as.

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

length between 0 and 60

Defines the data connection status.

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

required

Defines the media type to return the content.

Idempotency-Key

string

Defines the idempotency-key for the request.

Cache-Only

string

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

Response

204

The data connection was updated successfully.

Language


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://localhost:8080/v1/data_connections/id \
3
     --header 'Content-Type: application/json'

Click Try It! to start a request and see the response here!