---
title: "Read a service action specification"
method: GET
path: "/service_specification/{serviceSpecificationId}/action_specification/{id}"
tags: ["Action"]
---

# Read a service action specification

`GET /service_specification/{serviceSpecificationId}/action_specification/{id}`

Read an action specification of a service specification

## Path parameters

- `id` string, uuid, required — Unique identifier for the entity represented as a UUID
- `serviceSpecificationId` string, uuid, required — Unique identifier for the entity represented as a UUID

## Query parameters

- `service_id` string, uuid
- `link_id` string, uuid
- `application_id` integer
- `scope_id` integer
- `dimensions` string

## Response `2XX`

Object representing action specifications

- object — Object representing action specifications
  - `id` string, uuid — Unique identifier for the entity represented as a UUID
  - `created_at` string, date
  - `updated_at` string, date
  - `type` 'create' | 'update' | 'delete' | 'archive' | 'unarchive' | 'custom' | 'diagnose' — Type of the action. Should be one of the specified values in the ActionType enumeration
  - `parameters` Def7 — 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` Def7 — 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
  - `service_specification_id` union — Unique identifier for the associated service specification
    - string, uuid — Unique identifier for the entity represented as a UUID
    - string
  - `link_specification_id` union — Unique identifier for the associated link specification
    - string, uuid — Unique identifier for the entity represented as a UUID
    - string
  - `retryable` boolean — Indicates whether the action can be retried if the instance is in a failed state.
  - `parallelize` boolean — Indicates whether multiple instances of this action can be executed in parallel. Only applicable to custom type actions.
  - `annotations` Def11 — Object representing annotations with key-value pairs
    - `runs_over` 'deployment' | 'scope' | 'instance' — Entity type over which the action applies
    - `show_on` string[]
  - `external` Def12, nullable — Configuration for resolving external context data via the nullplatform agent
    - `action` string, required — Action to send to the agent for resolving external data
    - `output_schema` object, required — JSON Schema to validate the agent response against
  - `enabled_when` string — Condition that must be met for the action to run
  - `icon` string — Icon associated with the action. Format: 'icon-set:icon-variation'. Empty string to clear.
  - `enabled` boolean — Indicates if the action is enabled depending on enabled_when
  - `external_resolution` object — Status of the external context resolution when the action specification was read
    - `status` string, required — Resolution outcome. One of: success, no_channel, agent_error, timeout, auth_error, service_unavailable, invalid_response
    - `error` string — Human-readable error detail when status is not success
    - `notification_id` string — ID of the notification sent to the agent. Present on error statuses to facilitate debugging

## Other responses

- `4XX` — Format for representing errors during API interactions
- `5XX` — Format for representing errors during API interactions

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) · [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nullplatform/nullplatform-api/revisions/1c4ea154b159/schema)