Sign in
Action

Update a service specification action

Updates a service specification action

patch/service_specification/{serviceSpecificationId}/action_specification/{id}

Path parameters

idstring uuid required

Unique identifier for the entity represented as a UUID

serviceSpecificationIdstring uuid required

Unique identifier for the entity represented as a UUID

Request body

retryableboolean

Indicates whether the action can be retried if the instance is in a failed state.

parallelizeboolean

Indicates whether multiple instances of this action can be executed in parallel. Only applicable to custom type actions.

iconstring

Icon associated with the action. Format: 'icon-set:icon-variation'. Empty string to clear.

Example request

{
  "name": "my-link-specification",
  "type": "custom",
  "parameters": {
    "schema": {
      "type": "object",
      "properties": {
        "my_string_property": {
          "type": "string"
        },
        "my_number_property": {
          "type": "number",
          "default": 0
        }
      },
      "required": [
        "my_string_property"
      ]
    },
    "values": {}
  },
  "results": {
    "schema": {
      "type": "object",
      "properties": {
        "my_string_property": {
          "type": "string"
        },
        "my_number_property": {
          "type": "number",
          "default": 0
        }
      },
      "required": [
        "my_string_property"
      ]
    },
    "values": {}
  },
  "service_specification_id": "134544a6-a089-43ba-9d52-5b6e6e4fa8d1",
  "link_specification_id": "f3e8be90-0952-4506-bd54-c4e75a5a4393",
  "retryable": true,
  "parallelize": true,
  "enabled_when": ".service.dimensions.environment == \"development\"",
  "annotations": {
    "runs_over": "scope",
    "show_on": [
      "scope",
      "performance"
    ]
  }
}

Response

Object representing action specifications

idstring uuid

Unique identifier for the entity represented as a UUID

created_atstring date
updated_atstring date
type'create' | 'update' | 'delete' | 'archive' | 'unarchive' | 'custom' | 'diagnose'

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

retryableboolean

Indicates whether the action can be retried if the instance is in a failed state.

parallelizeboolean

Indicates whether multiple instances of this action can be executed in parallel. Only applicable to custom type actions.

enabled_whenstring

Condition that must be met for the action to run

iconstring

Icon associated with the action. Format: 'icon-set:icon-variation'. Empty string to clear.

enabledboolean

Indicates if the action is enabled depending on enabled_when

Example response

{
  "name": "my-link-specification",
  "type": "custom",
  "parameters": {
    "schema": {
      "type": "object",
      "properties": {
        "my_string_property": {
          "type": "string"
        },
        "my_number_property": {
          "type": "number",
          "default": 0
        }
      },
      "required": [
        "my_string_property"
      ]
    },
    "values": {}
  },
  "results": {
    "schema": {
      "type": "object",
      "properties": {
        "my_string_property": {
          "type": "string"
        },
        "my_number_property": {
          "type": "number",
          "default": 0
        }
      },
      "required": [
        "my_string_property"
      ]
    },
    "values": {}
  },
  "service_specification_id": "134544a6-a089-43ba-9d52-5b6e6e4fa8d1",
  "link_specification_id": "f3e8be90-0952-4506-bd54-c4e75a5a4393",
  "retryable": true,
  "parallelize": true,
  "enabled_when": ".service.dimensions.environment == \"development\"",
  "annotations": {
    "runs_over": "scope",
    "show_on": [
      "scope",
      "performance"
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.