Claim an authorized session operation on the live controller generation#

PropertyValue
Servicecrossfire
OperationclaimFleetRuntime
MethodPUT
Path/api/fleets/{fleetId}/session-operations/{operationId}/claim
Authenticationfleet
Success status200
Response dataUnpaginated value
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codesNone declared

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

Path parameters#

object; fields below; unknown fields rejected

Field pathRepresentation and constraints
fleetIdlowercase opaque UUID
operationIdlowercase opaque UUID

Validation#

check.object({ fleetId: check.identifier, operationId: check.identifier })

Referenced definitions:

Query parameters#

custom validation: none ; see function below

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function none(input: unknown) {
    const parsed = listQuery([])(input);
    return parsed.ok ? success({}) : parsed;
}

Validation#

query.none

Referenced definitions:

Request body#

object; fields below; unknown fields rejected ( runtimeClaim )

Field pathRepresentation and constraints
connectionIdlowercase opaque UUID

Validation#

fleetRuntime.runtimeClaim

Referenced definitions:

Response data#

object; fields below; unknown fields rejected; constraint: Invalid session operation outcome ( runtimeOperation )

Field pathRepresentation and constraints
operationIdlowercase opaque UUID
fleetIdlowercase opaque UUID
agentIdlowercase opaque UUID; JSON null permitted
actionstart or stop or reset ( runtimeAction )
expectedRevisionexact JSON integer; 0…9007199254740991
statuspending or running or succeeded or failed
createdAtexact JSON integer; 0…9007199254740991
completedAtexact JSON integer; 0…9007199254740991; JSON null permitted
errorMessagestring; 1–4096 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted

Additional checks#

The following checks apply in addition to the field limits.

Constraint on object:

value => (value.status === 'succeeded' || value.status === 'failed') === (value.completedAt !== null)
    && (value.status === 'failed') === (value.errorMessage !== null)

Validation#

fleetRuntime.runtimeOperation

Referenced definitions:

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001"
  }
}