NUnullplatform
Action

Read an action specification

Changed on

Read an action specification of a service or link.

get/action_specification/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/action_specification/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Unique identifier for the entity represented as a UUID

Query parameters

service_idstring uuid

Service ID for dynamic additional properties

link_idstring uuid

Link ID for dynamic additional properties

application_idinteger

Application ID for dynamic additional properties

scope_idinteger

Scope ID for dynamic additional properties

dimensionsstring

Dimension key-value pairs used for dynamic additional properties

package_revision_idstring uuid

Package revision to resolve the specification against. The response is the snapshot this revision pins instead of the live specification, and the request fails when the revision does not include the specification. Useful before an instance exists, for example to render a create form

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