Skip to main content

Create a service specification action

Create a service specification action

Path Parameters
serviceSpecificationId string REQUIRED
Request Body REQUIRED

Object representing action specifications

name string REQUIRED

Possible values: 1 ≤ length

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

parameters object

Object representing an attribute with a schema and associated values

schema object REQUIRED

Specification of the attribute schema. Must be a valid JSON Schema

values object REQUIRED

Values associated with the attribute. Must validate against provided schema

results object

Object representing an attribute with a schema and associated values

schema object REQUIRED

Specification of the attribute schema. Must be a valid JSON Schema

values object REQUIRED

Values associated with the attribute. Must validate against provided schema

type string

Possible values: [create, update, delete, custom]

Type of the action. Should be one of the specified values in the ActionType enumeration

service_specification_id

Unique identifier for the associated service specification

link_specification_id

Unique identifier for the associated link specification

Responses
2XX

Object representing action specifications

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 specification. Automatically generated from "name"

created_at date OPTIONAL
updated_at date OPTIONAL
type string OPTIONAL

Possible values: [create, update, delete, custom]

Type of the action. Should be one of the specified values in the ActionType enumeration

parameters object OPTIONAL

Object representing an attribute with a schema and associated values

schema object

Specification of the attribute schema. Must be a valid JSON Schema

values object

Values associated with the attribute. Must validate against provided schema

results object OPTIONAL

Object representing an attribute with a schema and associated values

schema object

Specification of the attribute schema. Must be a valid JSON Schema

values object

Values associated with the attribute. Must validate against provided schema

service_specification_id OPTIONAL

Unique identifier for the associated service specification

link_specification_id OPTIONAL

Unique identifier for the associated link specification

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