Skip to content
KataraKatara documentation

Read an action's reconciliation

GET
/katara/v1/orgs/{org}/environments/{environment}/actions/{id}/reconciliation
curl --request GET \
  --url https://api.katara.com/katara/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/actions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/reconciliation \
  --header 'Authorization: Bearer <token>'

Requires locus:actions:read. Found only for an external runtime’s action whose outcome was unknown; any other action is not found here. Key resource restrictions match resource_id. Workload credentials are refused. It carries the outcome, the action’s tool unit and the resolution once one is recorded, never the action’s input or the tool’s output.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string format: uuid
environment
required
string format: uuid
id
required
string format: uuid

Header Parameters

Section titled “Header Parameters”
X-Katara-Account-ID
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/

Optional for reads after sign-in. Use the UUID of the account that loaded the application. A different current cookie account returns account_changed before the handler runs. Session bearer and API key clients do not require this header.

Responses

Section titled “Responses”

200

Section titled “200”

The action and its unit.

Media typeapplication/json

An external runtime’s action whose outcome is unknown, and its resolution once there is one. It carries identifiers, states, amounts and times, never the action’s input or the tool’s output. unit is absent when the action had no tool unit.

object
action_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
mode
required
string
Allowed values: test live
agent_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
resource_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
effect
required
string
Allowed values: read_only idempotent_write non_idempotent_write
claimed_at
required
string format: date-time
outcome
required

The call ended without a reply anyone could trust, so nobody knows whether the effect happened.

string
Allowed value: unknown
observed_at
required
string format: date-time
unit

The action’s one tool unit as its budget holds it.

object
price
required

The tool tariff the action was admitted at, in atomic credit units (nine decimal places).

integer
>= 1 <= 9007199254740991
state
required

Held: reserved and not yet decided. unknown: reserved and marked as awaiting reconciliation once no call could still be running. charged: the unit was spent. released: it was returned to the budget.

string
Allowed values: held unknown charged released
charged
required
integer
<= 9007199254740991
resolution

What the owner or admin who resolved the action recorded. Written once and never changed.

object
outcome
required
string
Allowed values: completed not_completed
reference
required
string
>= 3 characters <= 200 characters
note
required
string
>= 1 characters <= 2000 characters
unit_outcome

What the record did to the unit. Absent when the action had none.

string
Allowed values: charged released
recorded_by
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
recorded_at
required
string format: date-time
operation_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "mode": "test",
  "effect": "read_only",
  "outcome": "unknown",
  "unit": {
    "state": "held"
  },
  "resolution": {
    "outcome": "completed",
    "unit_outcome": "charged"
  }
}

400

Section titled “400”

Invalid ID or a query.

403

Section titled “403”

Current scoped read authority is unavailable.

404

Section titled “404”

The action’s outcome was not unknown, or the action is unavailable.

500

Section titled “500”

The action or its authority could not be checked.