Skip to main content

Create a link action

Create a link action

Path Parameters
linkId string REQUIRED
Request Body REQUIRED

Object representing instances

name string

Possible values: 1 ≤ length

Name of the entity. Must be a non-empty string and not equal to null

specification_id uuid REQUIRED

Unique identifier for the entity represented as a UUID

desired_specification_id

Desired unique identifier for the associated specification

messages object[]
level string

Possible values: [debug, info, information, warn, warning, error, fatal]

Message severity level. Defaults to "info"

message string REQUIRED

The actual message content

parameters object

Parameters associated with the action

results object

Results produced by the action

status string

Possible values: [pending_create, pending, in_progress, success, failed]

Status of the action. Should be one of the specified values in the ActionStatus enumeration

service_id uuid

Unique identifier for the entity represented as a UUID

link_id uuid

Unique identifier for the entity represented as a UUID

Responses
2XX

Object representing instances

Schema OPTIONAL
id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

name string OPTIONAL

Possible values: 1 ≤ length

Name of the entity. Must be a non-empty string and not equal to null

slug string OPTIONAL

Possible values: 1 ≤ length

Slug of the entity. Automatically generated from "name"

specification_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

desired_specification_id OPTIONAL

Desired unique identifier for the associated specification

messages object[] OPTIONAL
level string OPTIONAL

Possible values: [debug, info, information, warn, warning, error, fatal]

Message severity level. Defaults to "info"

message string

The actual message content

created_at date OPTIONAL
updated_at date OPTIONAL
status string OPTIONAL

Possible values: [pending_create, pending, in_progress, success, failed]

Status of the action. Should be one of the specified values in the ActionStatus enumeration

parameters object OPTIONAL

Parameters associated with the action

results object OPTIONAL

Results produced by the action

service_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

link_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

4XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context

5XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context