Data Sinks

Get a data sink

Get a data sink based on it's id

GET/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceId*string

dataSinkId*any

Data sink id

Example: "123e4567-e89b-12d3-a456-426614174000"

Header parameters

Response

200

Data sink fetched successfully

Body

application/json

id*string

Unique identifier of the data sink. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

workspaceId*string

Unique identifier of the workspace. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

label*string

Label of the data sink

Example: "Local python instance"

description*string

Description of the data sink

Example: "This is a local python instance that runs on the local machine. Calculates the sum of two numbers."

tags*string

Tags associated with the data sink

Example: "python, local, sum"

icon*all of

Icon of the data sink

Example: "{ source: 'DevIcon', name: 'python' }"

visibleId*string

Visible identifier of the data sink. Unique within the organization. It's used in the calculations to refer to the data sink.

Example: "SNK-1"

serial*number

Serial number of the data sink. The visible identifier is generated using this serial number.

Example: 1

entries*array of DataSinkEntryRto (object)

Entries of the data sink

updatedAt*string (date-time)

updatedBy*string

createdAt*string (date-time)

createdBy*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/{dataSinkId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "label": "Local python instance",
  "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
  "tags": "python, local, sum",
  "icon": "{ source: 'DevIcon', name: 'python' }",
  "visibleId": "SNK-1",
  "serial": 1,
  "entries": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "sum",
      "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
      "value": "3",
      "dataType": "scalar",
      "updatedAt": "2024-11-21T07:08:34.229Z",
      "updatedBy": "text",
      "createdAt": "2024-11-21T07:08:34.229Z",
      "createdBy": "text"
    }
  ],
  "updatedAt": "2024-11-21T07:08:34.229Z",
  "updatedBy": "text",
  "createdAt": "2024-11-21T07:08:34.229Z",
  "createdBy": "text"
}

Get all data sinks including their entries

Get all data sinks including their entries

GET/v1/workspace/{workspaceId}/data-sink

Path parameters

workspaceId*string

Header parameters

Response

200

Data sinks fetched successfully

Body

application/json

id*string

Unique identifier of the data sink. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

workspaceId*string

Unique identifier of the workspace. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

label*string

Label of the data sink

Example: "Local python instance"

description*string

Description of the data sink

Example: "This is a local python instance that runs on the local machine. Calculates the sum of two numbers."

tags*string

Tags associated with the data sink

Example: "python, local, sum"

icon*all of

Icon of the data sink

Example: "{ source: 'DevIcon', name: 'python' }"

visibleId*string

Visible identifier of the data sink. Unique within the organization. It's used in the calculations to refer to the data sink.

Example: "SNK-1"

serial*number

Serial number of the data sink. The visible identifier is generated using this serial number.

Example: 1

entries*array of DataSinkEntryRto (object)

Entries of the data sink

updatedAt*string (date-time)

updatedBy*string

createdAt*string (date-time)

createdBy*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "label": "Local python instance",
    "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
    "tags": "python, local, sum",
    "icon": "{ source: 'DevIcon', name: 'python' }",
    "visibleId": "SNK-1",
    "serial": 1,
    "entries": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "key": "sum",
        "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
        "value": "3",
        "dataType": "scalar",
        "updatedAt": "2024-11-21T07:08:34.229Z",
        "updatedBy": "text",
        "createdAt": "2024-11-21T07:08:34.229Z",
        "createdBy": "text"
      }
    ],
    "updatedAt": "2024-11-21T07:08:34.229Z",
    "updatedBy": "text",
    "createdAt": "2024-11-21T07:08:34.229Z",
    "createdBy": "text"
  }
]

Get a data sink entry

Get a data sink entry based on it's key

GET/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}

Path parameters

workspaceId*string

key*any

Data sink entry key

Example: "sum"

dataSinkId*any

Data sink id

Example: "123e4567-e89b-12d3-a456-426614174000"

Header parameters

Response

200

Data sink entry fetched successfully

Body

application/json

id*string

Unique identifier of the data sink entry. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

key*string

Key of the data sink entry

Example: "sum"

dataSinkId*string

Id of the data sink

Example: "123e4567-e89b-12d3-a456-426614174000"

value*string

Value of the data sink entry

Example: "3"

dataType*string

Data type of the data sink entry

Example: "scalar"

updatedAt*string (date-time)

updatedBy*string

createdAt*string (date-time)

createdBy*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2024-11-21T07:08:34.229Z",
  "updatedBy": "text",
  "createdAt": "2024-11-21T07:08:34.229Z",
  "createdBy": "text"
}

Update a data sink

Update a data sink based on it's id

PATCH/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceId*string

dataSinkId*any

Data sink id

Example: "123e4567-e89b-12d3-a456-426614174000"

Header parameters

Body

application/json

labelstring

Unique identifier of the data sink (UUIDv4). Specify only when its necessary to know the id before creation.

Example: "123e4567-e89b-12d3-a456-426614174000"

descriptionstring

Description of the data sink

Example: "This is a local python instance that runs on the local machine. Calculates the sum of two numbers."

tagsstring

Tags associated with the data sink

Example: "python, local, sum"

iconall of

Icon of the data sink

Response

200

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/{dataSinkId}', {
    method: 'PATCH',
    headers: {
      "ClientId": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a data sink

Delete a data sink based on it's id

DELETE/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceId*string

dataSinkId*any

Data sink id

Example: "123e4567-e89b-12d3-a456-426614174000"

Header parameters

Response

200

Data sink deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/{dataSinkId}', {
    method: 'DELETE',
    headers: {
      "ClientId": "text"
    },
});
const data = await response.json();

Update a data sink entry

Update a data sink entry based on it's key

PATCH/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}

Path parameters

workspaceId*string

key*any

Data sink entry key

Example: "sum"

dataSinkId*any

Data sink id

Example: "123e4567-e89b-12d3-a456-426614174000"

Header parameters

Body

application/json

valuestring

Value of the data sink entry

Example: "3"

dataTypestring

Data type of the data sink entry

Example: "scalar"

Response

200

Data sink entry updated successfully

Body

application/json

id*string

Unique identifier of the data sink entry. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

key*string

Key of the data sink entry

Example: "sum"

dataSinkId*string

Id of the data sink

Example: "123e4567-e89b-12d3-a456-426614174000"

value*string

Value of the data sink entry

Example: "3"

dataType*string

Data type of the data sink entry

Example: "scalar"

updatedAt*string (date-time)

updatedBy*string

createdAt*string (date-time)

createdBy*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}', {
    method: 'PATCH',
    headers: {
      "ClientId": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2024-11-21T07:08:34.229Z",
  "updatedBy": "text",
  "createdAt": "2024-11-21T07:08:34.229Z",
  "createdBy": "text"
}

Delete a data sink entry

Delete a data sink entry based on it's key

DELETE/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}

Path parameters

workspaceId*string

key*any

Data sink entry key

Example: "sum"

dataSinkId*any

Data sink id

Example: "123e4567-e89b-12d3-a456-426614174000"

Header parameters

Response

200

Data sink entry deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}', {
    method: 'DELETE',
    headers: {
      "ClientId": "text"
    },
});
const data = await response.json();

Get all data sinks excluding their entries

Get all data sinks. Entries are excluded in the response.

GET/v1/workspace/{workspaceId}/data-sink/list

Path parameters

workspaceId*string

Header parameters

Response

200

Data sinks fetched successfully

Body

application/json

id*string

Unique identifier of the data sink. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

workspaceId*string

Unique identifier of the workspace. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

label*string

Label of the data sink

Example: "Local python instance"

description*string

Description of the data sink

Example: "This is a local python instance that runs on the local machine. Calculates the sum of two numbers."

tags*string

Tags associated with the data sink

Example: "python, local, sum"

icon*all of

Icon of the data sink

Example: "{ source: 'DevIcon', name: 'python' }"

visibleId*string

Visible identifier of the data sink. Unique within the organization. It's used in the calculations to refer to the data sink.

Example: "SNK-1"

serial*number

Serial number of the data sink. The visible identifier is generated using this serial number.

Example: 1

updatedAt*string (date-time)

updatedBy*string

createdAt*string (date-time)

createdBy*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "label": "Local python instance",
    "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
    "tags": "python, local, sum",
    "icon": "{ source: 'DevIcon', name: 'python' }",
    "visibleId": "SNK-1",
    "serial": 1,
    "updatedAt": "2024-11-21T07:08:34.229Z",
    "updatedBy": "text",
    "createdAt": "2024-11-21T07:08:34.229Z",
    "createdBy": "text"
  }
]

Create a new data sink

Create a new data sink. Entries are optional

POST/v1/workspace/{workspaceId}/data-sink

Path parameters

workspaceId*string

Header parameters

Body

application/json

idstring

Unique identifier of the data sink (UUIDv4). Specify only when its necessary to know the id before creation.

Example: "123e4567-e89b-12d3-a456-426614174000"

label*string

Label of the data sink

Example: "Local python instance"

descriptionstring

Description of the data sink

Example: "This is a local python instance that runs on the local machine. Calculates the sum of two numbers."

tagsstring

Tags associated with the data sink

Example: "python, local, sum"

iconall of

Icon of the data sink

entriesarray of CreateDataSinkEntryDto (object)

Response

201

Data sink created successfully

Body

application/json

id*string

Unique identifier of the data sink. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

workspaceId*string

Unique identifier of the workspace. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

label*string

Label of the data sink

Example: "Local python instance"

description*string

Description of the data sink

Example: "This is a local python instance that runs on the local machine. Calculates the sum of two numbers."

tags*string

Tags associated with the data sink

Example: "python, local, sum"

icon*all of

Icon of the data sink

Example: "{ source: 'DevIcon', name: 'python' }"

visibleId*string

Visible identifier of the data sink. Unique within the organization. It's used in the calculations to refer to the data sink.

Example: "SNK-1"

serial*number

Serial number of the data sink. The visible identifier is generated using this serial number.

Example: 1

entries*array of DataSinkEntryRto (object)

Entries of the data sink

updatedAt*string (date-time)

updatedBy*string

createdAt*string (date-time)

createdBy*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink', {
    method: 'POST',
    headers: {
      "ClientId": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "label": "Local python instance"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "label": "Local python instance",
  "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
  "tags": "python, local, sum",
  "icon": "{ source: 'DevIcon', name: 'python' }",
  "visibleId": "SNK-1",
  "serial": 1,
  "entries": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "sum",
      "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
      "value": "3",
      "dataType": "scalar",
      "updatedAt": "2024-11-21T07:08:34.229Z",
      "updatedBy": "text",
      "createdAt": "2024-11-21T07:08:34.229Z",
      "createdBy": "text"
    }
  ],
  "updatedAt": "2024-11-21T07:08:34.229Z",
  "updatedBy": "text",
  "createdAt": "2024-11-21T07:08:34.229Z",
  "createdBy": "text"
}

Create a new data sink entry

Create a new data sink entry based on it's key

POST/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceId*string

dataSinkId*any

Data sink id

Example: "123e4567-e89b-12d3-a456-426614174000"

Header parameters

Body

application/json

idstring

Unique identifier of the data sink entry (UUIDv4). Specify only when its necessary to know the id before creation.

Example: "123e4567-e89b-12d3-a456-426614174000"

key*string

Key of the data sink entry

Example: "sum"

valuestring

Value of the data sink entry

Example: "3"

dataType*string

Data type of the data sink entry

Example: "scalar"

Response

201

Data sink entry created successfully

Body

application/json

id*string

Unique identifier of the data sink entry. UUIDv4

Example: "123e4567-e89b-12d3-a456-426614174000"

key*string

Key of the data sink entry

Example: "sum"

dataSinkId*string

Id of the data sink

Example: "123e4567-e89b-12d3-a456-426614174000"

value*string

Value of the data sink entry

Example: "3"

dataType*string

Data type of the data sink entry

Example: "scalar"

updatedAt*string (date-time)

updatedBy*string

createdAt*string (date-time)

createdBy*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/data-sink/{dataSinkId}', {
    method: 'POST',
    headers: {
      "ClientId": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "sum",
      "dataType": "scalar"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2024-11-21T07:08:34.229Z",
  "updatedBy": "text",
  "createdAt": "2024-11-21T07:08:34.229Z",
  "createdBy": "text"
}