Kair Harbor Express · KHEMS

KHEMS API reference

Read-only HTTP documentation for operations and integrations.

API base URL: https://api.kairharborexpress.com

Contract version 2.2.0

Using the API

Protected operations require an active bearer session in the Authorization header, plus the listed permissions and facility access. Documentation and public health require no sign-in.

Responses keep endpoint-specific envelopes. A 401 indicates an invalid or missing session; a 403 indicates insufficient access. A 503 may indicate uncertain verification or a provider failure. Follow each operation’s response schema.

Where supported, body operationId is the retry identity. Preserve the actor and payload when resolving uncertain completion. Do not automatically retry mutations or invent an Idempotency-Key header. Pagination and concurrency rules remain endpoint-specific.

This reference describes the authored contract; it does not verify enabled capabilities or provider readiness. Expand an operation for its parameters, request body and responses.

reference

GET /Read the KHEMS API reference

Available only on api.kairharborexpress.com. HEAD returns GET response headers with no body. Operational OPTIONS retains shared preflight handling.

Parameters

No query or path parameters documented.

Responses

200

Static reference generated from the API contract.

text/html

References: #/components/schemas/ApiReferenceHtml

{
  "schema": {
    "$ref": "#/components/schemas/ApiReferenceHtml"
  }
}

405

Only GET and HEAD are supported. Allow: GET, HEAD.

text/plain

{
  "schema": {
    "type": "string"
  }
}

Response headers

{
  "Allow": {
    "schema": {
      "type": "string",
      "const": "GET, HEAD"
    }
  }
}

default

Documentation is static and does not access user or provider data.

HEAD /Read the KHEMS API reference

Available only on api.kairharborexpress.com. HEAD returns GET response headers with no body. Operational OPTIONS retains shared preflight handling.

Parameters

No query or path parameters documented.

Responses

200

Headers for the static reference; no response body.

405

Only GET and HEAD are supported. Allow: GET, HEAD.

text/plain

{
  "schema": {
    "type": "string"
  }
}

Response headers

{
  "Allow": {
    "schema": {
      "type": "string",
      "const": "GET, HEAD"
    }
  }
}

default

Documentation is static and does not access user or provider data.

GET /openapi.jsonDownload the public OpenAPI contract

Available only on api.kairharborexpress.com. HEAD returns GET response headers with no body. Operational OPTIONS retains shared preflight handling.

Parameters

No query or path parameters documented.

Responses

200

Static reference generated from the API contract.

application/json

References: #/components/schemas/PublicOpenApiDocument

{
  "schema": {
    "$ref": "#/components/schemas/PublicOpenApiDocument"
  }
}

405

Only GET and HEAD are supported. Allow: GET, HEAD.

text/plain

{
  "schema": {
    "type": "string"
  }
}

Response headers

{
  "Allow": {
    "schema": {
      "type": "string",
      "const": "GET, HEAD"
    }
  }
}

default

Documentation is static and does not access user or provider data.

HEAD /openapi.jsonDownload the public OpenAPI contract

Available only on api.kairharborexpress.com. HEAD returns GET response headers with no body. Operational OPTIONS retains shared preflight handling.

Parameters

No query or path parameters documented.

Responses

200

Headers for the static reference; no response body.

405

Only GET and HEAD are supported. Allow: GET, HEAD.

text/plain

{
  "schema": {
    "type": "string"
  }
}

Response headers

{
  "Allow": {
    "schema": {
      "type": "string",
      "const": "GET, HEAD"
    }
  }
}

default

Documentation is static and does not access user or provider data.

facilities

GET /facilitiesList facilities

Default service=yms preserves the existing YMS-authorized warehouse list and capabilities. service=admin returns shared warehouse/transport metadata, including inactive facilities, only for ADMIN.MANAGE_USERS or ADMIN.MANAGE_FACILITIES. Query parameters never grant access.

Parameters

service in query · optional

{
  "type": "string",
  "enum": [
    "yms",
    "admin"
  ],
  "default": "yms"
}

Responses

200

YMS facilities by default, or all managed operating units with service=admin. Administration view includes inactive units; external resource IDs are not returned.

application/json

References: #/components/schemas/Facilities, #/components/schemas/ManagedFacility

{
  "schema": {
    "type": "object",
    "required": [
      "allowed",
      "body",
      "correlationId"
    ],
    "properties": {
      "allowed": {
        "const": true
      },
      "correlationId": {
        "type": "string"
      },
      "body": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/Facilities"
          },
          {
            "type": "object",
            "required": [
              "facilities"
            ],
            "properties": {
              "facilities": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ManagedFacility"
                }
              }
            }
          }
        ]
      }
    }
  }
}

References: #/components/responses/FacilityListResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /facilitiesCreate a facility

Administrator-authorized, audited creation. operationId binds the actor and immutable input for safe retries. Optional YMS setup retains provider-readiness validation. Request size limited to 16 KiB.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/FacilityCreate

{
  "schema": {
    "$ref": "#/components/schemas/FacilityCreate"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

201

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

400

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

404

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

409

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /facilities/{facilityId}Read facility metadata

Parameters

facilityId in path · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Shared facility metadata

application/json

References: #/components/schemas/ManagedFacility

{
  "schema": {
    "type": "object",
    "required": [
      "allowed",
      "body",
      "correlationId"
    ],
    "properties": {
      "allowed": {
        "const": true
      },
      "correlationId": {
        "type": "string"
      },
      "body": {
        "type": "object",
        "required": [
          "facility"
        ],
        "properties": {
          "facility": {
            "$ref": "#/components/schemas/ManagedFacility"
          }
        }
      }
    }
  }
}

400

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

404

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

409

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

PATCH /facilities/{facilityId}Edit facility metadata

Audited partial update of name, address, or timezone. Code, type, activation, and resource mappings are immutable through this operation. Requires expectedUpdatedAt to reject concurrent changes. Successful retries return the original receipt before rechecking that version. 16 KiB request limit.

Parameters

facilityId in path · required

{
  "type": "string",
  "format": "uuid"
}

Request body (required)

application/json

References: #/components/schemas/FacilityPatch

{
  "schema": {
    "$ref": "#/components/schemas/FacilityPatch"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

400

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

404

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

409

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /facilities/{facilityId}/disableDisable a facility

Disables a facility through the existing audited provisioning workflow. Retains data and requires a reason.

Parameters

facilityId in path · required

{
  "type": "string",
  "format": "uuid"
}

Request body (required)

application/json

{
  "schema": {
    "type": "object",
    "required": [
      "operationId",
      "reason"
    ],
    "additionalProperties": false,
    "properties": {
      "operationId": {
        "type": "string",
        "format": "uuid"
      },
      "reason": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1000
      },
      "facilityId": {
        "type": "string",
        "format": "uuid",
        "description": "Optional compatibility identity; must match the URL if supplied."
      }
    }
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

400

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

404

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

409

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

equipment

GET /equipmentYms Yard

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/EquipmentState

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/EquipmentState"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/EquipmentStateResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/queued-checkoutQueued Checkout

Request body bounded to 64 KiB. At most seven unique manifest photos. Same operation and immutable input are used for retries.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/QueuedObservation

{
  "schema": {
    "$ref": "#/components/schemas/QueuedObservation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/queued-checkout/photoQueued Checkout Photo

Multipart body bounded to 6 MiB. File up to 5 MiB; immutable manifest and reserved Drive object are checked before completion.

Parameters

No query or path parameters documented.

Request body (required)

multipart/form-data

References: #/components/schemas/QueuedPhoto

{
  "schema": {
    "$ref": "#/components/schemas/QueuedPhoto"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /equipment/queued-checkout/stateQueued Checkout State

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/movementsYms Asset Movement

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Observation

{
  "schema": {
    "$ref": "#/components/schemas/Observation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /equipment/movements/pendingYms Pending Reconciliations

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

cursor in query · optional

Opaque facility/snapshot-bound cursor; fixed page size 50.

{
  "type": "string",
  "maxLength": 1024
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/PendingMovements

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/PendingMovements"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/PendingMovementsResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /equipment/movements/recentYms Recent Responses

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/RecentMovements

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/RecentMovements"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/RecentMovementsResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/movements/correctYms Response Correction

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/ResponseCorrection

{
  "schema": {
    "$ref": "#/components/schemas/ResponseCorrection"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/updateYms Equipment Update

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/EquipmentUpdate

{
  "schema": {
    "$ref": "#/components/schemas/EquipmentUpdate"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/renameYms Equipment Rename

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/EquipmentRename

{
  "schema": {
    "$ref": "#/components/schemas/EquipmentRename"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/typeYms Equipment Type Correction

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/EquipmentType

{
  "schema": {
    "$ref": "#/components/schemas/EquipmentType"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/repairYms Repair

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Repair

{
  "schema": {
    "$ref": "#/components/schemas/Repair"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/ingateYms Ingate

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/checkoutYms Checkout

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/chassis/ingateYms Chassis Ingate

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /equipment/chassis/checkoutYms Chassis Checkout

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

yardchecks

GET /yardchecks/currentYms Yardcheck

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yardchecks/currentYms Yardcheck

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Yardcheck

{
  "schema": {
    "$ref": "#/components/schemas/Yardcheck"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /yardchecksYms Yardcheck History

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

limit in query · optional

{
  "type": "integer",
  "minimum": 1,
  "maximum": 50,
  "default": 20
}

beforeSequence in query · optional

Positive safe-integer sequence, supplied as a query string.

{
  "type": "string",
  "pattern": "^[1-9][0-9]*$"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yardchecks/correctionsYms Reconcile

Reads facility Corrections tab and applies up to 25 actionable rows. Sheet edits alone do not authorize changes; partial saves remain durable if Sheet status write fails.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/FacilityRequest

{
  "schema": {
    "$ref": "#/components/schemas/FacilityRequest"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/ReconciliationResult

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/ReconciliationResult"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/ReconciliationResultResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

visits

GET /visitsYms Active Visits

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/ActiveVisits

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/ActiveVisits"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/ActiveVisitsResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /visits/check-inYms Visit Check In

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/GateObservation

{
  "schema": {
    "$ref": "#/components/schemas/GateObservation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /visits/check-outYms Visit Check Out

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/GateObservation

{
  "schema": {
    "$ref": "#/components/schemas/GateObservation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /visits/close-driverYms Driver Visit Close

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/GateObservation

{
  "schema": {
    "$ref": "#/components/schemas/GateObservation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /visits/assign-dockYms Dock Assignment

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/DockAssignment

{
  "schema": {
    "$ref": "#/components/schemas/DockAssignment"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

documents

POST /documents/photoYms Photo

Bounded multipart upload (6 MiB request, 5 MiB file); may fail after movement is durably saved.

Parameters

No query or path parameters documented.

Request body (required)

multipart/form-data

References: #/components/schemas/PhotoUpload

{
  "schema": {
    "$ref": "#/components/schemas/PhotoUpload"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/PhotoReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/PhotoReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/PhotoReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /documents/photosYms Photo Search

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

q in query · optional

{
  "type": "string",
  "maxLength": 120
}

category in query · optional

References: #/components/schemas/PhotoCategory

{
  "$ref": "#/components/schemas/PhotoCategory"
}

date in query · optional

{
  "type": "string",
  "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}

pageToken in query · optional

{
  "type": "string",
  "maxLength": 2048
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/PhotoSearch

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/PhotoSearch"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/PhotoSearchResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

admin

GET /admin/provisioning/catalogProvisioning Catalog

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/provisioning/requestsProvisioning Requests

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

limit in query · optional

Clamped to 1..100; non-integer falls back to 25.

{
  "type": "integer",
  "default": 25
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/provisioning/usersUser Provisioning

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/UserProvision

{
  "schema": {
    "$ref": "#/components/schemas/UserProvision"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

201

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/sheets/maintenance/previewSheet Maintenance Preview

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/sheets/maintenance/applySheet Maintenance Apply

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/SheetMaintenance

{
  "schema": {
    "$ref": "#/components/schemas/SheetMaintenance"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/archives/statusArchive Retention Status

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

offset in query · optional

{
  "type": "integer",
  "minimum": 0,
  "default": 0
}

limit in query · optional

{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 100
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/archives/verifyArchive Prune Verification

Independent verification only; returns pruningEnabled=false. Never enables or invokes pruning.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/ArchiveVerification

{
  "schema": {
    "$ref": "#/components/schemas/ArchiveVerification"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/access/usersAccess Users

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

page in query · optional

{
  "type": "integer",
  "minimum": 1,
  "maximum": 800,
  "default": 1
}

q in query · optional

{
  "type": "string",
  "maxLength": 160
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/AccessUsers

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/AccessUsers"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/AccessUsersResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/access/rolesAccess Roles

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/AccessRoles

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/AccessRoles"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/AccessRolesResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/access/roleAccess Editor

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

roleId in query · optional

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/access/roleAccess Editor

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/AccessRoleEdit

{
  "schema": {
    "$ref": "#/components/schemas/AccessRoleEdit"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/access/assignmentsAccess Editor

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

userId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/access/assignmentsAccess Editor

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/AccessAssignmentsEdit

{
  "schema": {
    "$ref": "#/components/schemas/AccessAssignmentsEdit"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/healthProtected diagnostics

GET only. Requires canonical active session and global ADMIN.MANAGE_USERS. Probe failures remain in a 200 report; authorization probe uncertainty is 503/diagnostics_unavailable. format=html or Accept:text/html selects HTML unless format=json.

Parameters

format in query · optional

{
  "type": "string",
  "enum": [
    "html",
    "json"
  ]
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/Health

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/Health"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

text/html

{
  "schema": {
    "type": "string"
  }
}

Response headers

{
  "Cache-Control": {
    "schema": {
      "type": "string"
    },
    "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
  },
  "X-Correlation-ID": {
    "description": "Present on HTML diagnostics; JSON correlationId is in the envelope.",
    "schema": {
      "type": "string"
    }
  }
}

References: #/components/responses/HealthResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

405

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /admin/sessions/capabilitiesSession revocation capability

GET only; authentication and global authorization checked before reading capability state.

Parameters

No query or path parameters documented.

Responses

200

Capability state; boolean false by default. Provider uncertainty returns an error, never enabled=true.

application/json

References: #/components/schemas/Success, #/components/schemas/SessionRevocationCapability

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/SessionRevocationCapability"
          }
        },
        "required": [
          "body"
        ]
      }
    ]
  }
}

Response headers

{
  "Cache-Control": {
    "schema": {
      "type": "string"
    },
    "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
  }
}

References: #/components/responses/SessionRevocationCapabilityResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

405

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/session-revocationsRevoke user sessions

POST only. Canonical authentication and global authorization precede body validation. Completed receipt is idempotent for actor, target and operation ID; 409/operation_conflict on conflicting reuse. Capability disabled is 503/session_revocation_disabled; uncertain completion is 503/session_revocation_unavailable. Retry with the same IDs and no automatic replay. Backend validates exact completed receipt before reporting success.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/SessionRevocationRequest

{
  "schema": {
    "$ref": "#/components/schemas/SessionRevocationRequest"
  }
}

Responses

200

Completed or replayed receipt; both return 200. No automatic mutation replay.

application/json

References: #/components/schemas/Success, #/components/schemas/SessionRevocationReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/SessionRevocationReceipt"
          }
        },
        "required": [
          "body"
        ]
      }
    ]
  }
}

Response headers

{
  "Cache-Control": {
    "schema": {
      "type": "string"
    },
    "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
  }
}

References: #/components/responses/SessionRevocationResponse

400

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

404

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

405

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

409

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

413

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

415

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

workspace

GET /workspace/appsWorkspace Apps

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/WorkspaceApps

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/WorkspaceApps"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/WorkspaceAppsResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

session

GET /sessionSession

GET only. Missing bearer returns 200 with authenticated=false and session=null. Authenticated reads verify the provider and canonical session validity on every request. Invalid/revoked sessions return 401; uncertain verification returns 503 and must preserve local credentials and drafts. The same handler is reachable at the login origin /session before login page method handling.

Parameters

No query or path parameters documented.

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/Session

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/Session"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

Response headers

{
  "Cache-Control": {
    "schema": {
      "type": "string"
    },
    "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
  }
}

References: #/components/responses/SessionResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

405

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

health

GET /healthHealth

GET only. Returns the success envelope with body {status:ok}; does not probe providers, reveal configuration, or certify readiness. HTML diagnostics moved to protected /admin/health.

Parameters

No query or path parameters documented.

Responses

200

Public process liveness only; no dependency probes or readiness guarantee.

application/json

References: #/components/schemas/Success, #/components/schemas/PublicHealth

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/PublicHealth"
          }
        },
        "required": [
          "body"
        ]
      }
    ]
  }
}

Response headers

{
  "Cache-Control": {
    "schema": {
      "type": "string"
    },
    "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
  }
}

References: #/components/responses/PublicHealthResponse

405

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

Compatibility aliases

These alternate URLs call the same handlers as their canonical endpoints. Use the linked canonical endpoint for new integrations.

GET /yms/facilitiesList facilities

Default service=yms preserves the existing YMS-authorized warehouse list and capabilities. service=admin returns shared warehouse/transport metadata, including inactive facilities, only for ADMIN.MANAGE_USERS or ADMIN.MANAGE_FACILITIES. Query parameters never grant access.

Parameters

service in query · optional

{
  "type": "string",
  "enum": [
    "yms",
    "admin"
  ],
  "default": "yms"
}

Responses

200

YMS facilities by default, or all managed operating units with service=admin. Administration view includes inactive units; external resource IDs are not returned.

application/json

References: #/components/schemas/Facilities, #/components/schemas/ManagedFacility

{
  "schema": {
    "type": "object",
    "required": [
      "allowed",
      "body",
      "correlationId"
    ],
    "properties": {
      "allowed": {
        "const": true
      },
      "correlationId": {
        "type": "string"
      },
      "body": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/Facilities"
          },
          {
            "type": "object",
            "required": [
              "facilities"
            ],
            "properties": {
              "facilities": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ManagedFacility"
                }
              }
            }
          }
        ]
      }
    }
  }
}

References: #/components/responses/FacilityListResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /yms/yardYms Yard

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/EquipmentState

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/EquipmentState"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/EquipmentStateResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /yms/yardcheckYms Yardcheck

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/yardcheckYms Yardcheck

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Yardcheck

{
  "schema": {
    "$ref": "#/components/schemas/Yardcheck"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /yms/yardchecksYms Yardcheck History

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

limit in query · optional

{
  "type": "integer",
  "minimum": 1,
  "maximum": 50,
  "default": 20
}

beforeSequence in query · optional

Positive safe-integer sequence, supplied as a query string.

{
  "type": "string",
  "pattern": "^[1-9][0-9]*$"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /yms/visitsYms Active Visits

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/ActiveVisits

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/ActiveVisits"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/ActiveVisitsResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/visits/check-inYms Visit Check In

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/GateObservation

{
  "schema": {
    "$ref": "#/components/schemas/GateObservation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/visits/check-outYms Visit Check Out

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/GateObservation

{
  "schema": {
    "$ref": "#/components/schemas/GateObservation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/visits/close-driverYms Driver Visit Close

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/GateObservation

{
  "schema": {
    "$ref": "#/components/schemas/GateObservation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/visits/assign-dockYms Dock Assignment

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/DockAssignment

{
  "schema": {
    "$ref": "#/components/schemas/DockAssignment"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/movementYms Asset Movement

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Observation

{
  "schema": {
    "$ref": "#/components/schemas/Observation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /yms/responsesYms Recent Responses

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/RecentMovements

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/RecentMovements"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/RecentMovementsResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/responses/correctYms Response Correction

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/ResponseCorrection

{
  "schema": {
    "$ref": "#/components/schemas/ResponseCorrection"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/equipment/updateYms Equipment Update

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/EquipmentUpdate

{
  "schema": {
    "$ref": "#/components/schemas/EquipmentUpdate"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/equipment/renameYms Equipment Rename

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/EquipmentRename

{
  "schema": {
    "$ref": "#/components/schemas/EquipmentRename"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/equipment/typeYms Equipment Type Correction

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/EquipmentType

{
  "schema": {
    "$ref": "#/components/schemas/EquipmentType"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/repairYms Repair

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Repair

{
  "schema": {
    "$ref": "#/components/schemas/Repair"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/ingateYms Ingate

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/checkoutYms Checkout

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/chassis/ingateYms Chassis Ingate

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/chassis/checkoutYms Chassis Checkout

Compatibility observation intake; direction and container/chassis equipment type are imposed by the handler. HTTP validates operation/facility identity; observation fields are retained and projected downstream.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/Operation

{
  "schema": {
    "$ref": "#/components/schemas/Operation"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/MovementReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/MovementReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/photoYms Photo

Bounded multipart upload (6 MiB request, 5 MiB file); may fail after movement is durably saved.

Parameters

No query or path parameters documented.

Request body (required)

multipart/form-data

References: #/components/schemas/PhotoUpload

{
  "schema": {
    "$ref": "#/components/schemas/PhotoUpload"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/PhotoReceipt

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/PhotoReceipt"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/PhotoReceiptResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

GET /yms/photosYms Photo Search

Existing endpoint; behavior and validation are owned by the linked source handler.

Parameters

facilityId in query · required

{
  "type": "string",
  "format": "uuid"
}

q in query · optional

{
  "type": "string",
  "maxLength": 120
}

category in query · optional

References: #/components/schemas/PhotoCategory

{
  "$ref": "#/components/schemas/PhotoCategory"
}

date in query · optional

{
  "type": "string",
  "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}

pageToken in query · optional

{
  "type": "string",
  "maxLength": 2048
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/PhotoSearch

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/PhotoSearch"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/PhotoSearchResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /yms/reconcileYms Reconcile

Reads facility Corrections tab and applies up to 25 actionable rows. Sheet edits alone do not authorize changes; partial saves remain durable if Sheet status write fails.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/FacilityRequest

{
  "schema": {
    "$ref": "#/components/schemas/FacilityRequest"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/ReconciliationResult

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/ReconciliationResult"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/ReconciliationResultResponse

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/provisioning/facilitiesCreate a facility

Administrator-authorized, audited creation. operationId binds the actor and immutable input for safe retries. Optional YMS setup retains provider-readiness validation. Request size limited to 16 KiB.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/FacilityCreate

{
  "schema": {
    "$ref": "#/components/schemas/FacilityCreate"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

201

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

400

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

404

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

409

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

POST /admin/provisioning/facilities/disableDisable a facility

Compatibility URL for facility disable. Supply facilityId in the body instead of the path; permission, audit and retry rules are unchanged.

Parameters

No query or path parameters documented.

Request body (required)

application/json

References: #/components/schemas/FacilityDisable

{
  "schema": {
    "$ref": "#/components/schemas/FacilityDisable"
  }
}

Responses

200

Existing success envelope; payload may include additional domain fields.

application/json

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Success"
      },
      {
        "type": "object",
        "properties": {
          "body": {
            "$ref": "#/components/schemas/JsonValue"
          }
        },
        "required": [
          "body"
        ],
        "additionalProperties": true
      }
    ]
  }
}

References: #/components/responses/JsonValueResponse

400

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

401

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

403

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

404

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

409

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

503

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

default

Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.

application/json

References: #/components/schemas/Error

{
  "schema": {
    "$ref": "#/components/schemas/Error"
  }
}

References: #/components/responses/Error

Schemas and reusable definitions

securitySchemes

bearerAuth
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Supabase user access token. Browser recovery and immediate revocation upgrades are coordinated separately; no cookie authentication is claimed by this contract."
}

schemas

JsonValue
{
  "description": "Extensible JSON returned by the backing RPC; domain fields are not frozen by this inventory."
}
Error

References: #/components/schemas/JsonValue

{
  "type": "object",
  "properties": {
    "allowed": {
      "const": false
    },
    "correlationId": {
      "type": "string"
    },
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "body": {
      "$ref": "#/components/schemas/JsonValue"
    }
  },
  "required": [
    "allowed",
    "correlationId",
    "error",
    "code",
    "body"
  ],
  "additionalProperties": true
}
Success

References: #/components/schemas/JsonValue

{
  "type": "object",
  "properties": {
    "allowed": {
      "const": true
    },
    "correlationId": {
      "type": "string"
    },
    "body": {
      "$ref": "#/components/schemas/JsonValue"
    }
  },
  "required": [
    "allowed",
    "correlationId",
    "body"
  ],
  "additionalProperties": true
}
Operation
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "facilityId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "operationId",
    "facilityId"
  ],
  "additionalProperties": true,
  "description": "Existing body operationId is the durable retry identity. No Idempotency-Key header is implemented."
}
Observation
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "facilityId": {
      "type": "string",
      "format": "uuid"
    },
    "direction": {
      "type": "string",
      "enum": [
        "inbound",
        "outbound"
      ]
    },
    "equipmentType": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "visitId": {
      "type": "string",
      "format": "uuid"
    },
    "containerNumber": {
      "type": "string"
    },
    "chassisNumber": {
      "type": "string"
    },
    "trailerNumber": {
      "type": "string"
    },
    "tractorNumber": {
      "type": "string"
    },
    "plate": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "occurredAt": {
      "type": "string"
    },
    "physicalConfirmed": {
      "type": "boolean"
    },
    "notes": {
      "type": "string"
    }
  },
  "required": [
    "operationId",
    "facilityId",
    "direction"
  ],
  "additionalProperties": true,
  "description": "The HTTP intake validates identity and direction, then journals the observation. Projection/business validation happens downstream. Do not apply the older unused validateAssetMovement/validateArrival schemas to this intake."
}
GateObservation

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "equipmentType": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "visitId": {
          "type": "string",
          "format": "uuid"
        },
        "departureType": {
          "type": "string"
        },
        "confirmed": {
          "type": "boolean"
        },
        "expectedArrivedAt": {
          "type": "string"
        },
        "occurredAt": {
          "type": "string"
        }
      },
      "additionalProperties": true,
      "description": "Direction is imposed by the handler; check-out maps departureType and confirmed, close-driver imposes driver-close/bobtail. Other observation fields are retained."
    }
  ]
}
QueuedObservation

References: #/components/schemas/Observation, #/components/schemas/PhotoManifestItem

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Observation"
    },
    {
      "type": "object",
      "properties": {
        "recordedByUserId": {
          "type": "string",
          "format": "uuid"
        },
        "photoManifest": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PhotoManifestItem"
          },
          "maxItems": 7
        }
      },
      "required": [
        "recordedByUserId",
        "photoManifest"
      ],
      "additionalProperties": true
    }
  ]
}
PhotoManifestItem

References: #/components/schemas/PhotoCategory

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "digestSHA256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "mimeType": {
      "type": "string",
      "enum": [
        "image/jpeg",
        "image/png",
        "image/webp"
      ]
    },
    "category": {
      "$ref": "#/components/schemas/PhotoCategory"
    },
    "caption": {
      "type": "string",
      "maxLength": 240
    },
    "capturedAt": {
      "type": "string",
      "maxLength": 40
    }
  },
  "required": [
    "id",
    "digestSHA256",
    "mimeType",
    "category",
    "caption",
    "capturedAt"
  ],
  "additionalProperties": true
}
PhotoCategory
{
  "type": "string",
  "enum": [
    "container",
    "empty_container",
    "chassis",
    "seal",
    "tractor",
    "plate",
    "trailer",
    "visitor_id",
    "driver_id",
    "other"
  ]
}
Repair

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "containerNumber": {
          "type": "string"
        },
        "oldChassisNumber": {
          "type": "string"
        },
        "newChassisNumber": {
          "type": "string"
        },
        "pairConfirmed": {
          "const": true
        }
      },
      "required": [
        "containerNumber",
        "oldChassisNumber",
        "newChassisNumber",
        "pairConfirmed"
      ],
      "additionalProperties": true
    }
  ]
}
EquipmentUpdate

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "containerVisitId": {
          "type": "string",
          "format": "uuid"
        },
        "action": {
          "type": "string",
          "enum": [
            "mount",
            "unmount",
            "set_load_status"
          ]
        },
        "physicalConfirmed": {
          "const": true
        },
        "expectedUpdatedAt": {
          "type": "string"
        },
        "expectedChassis": {
          "type": "string"
        },
        "expectedLoadStatus": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "loaded",
            "empty",
            null
          ]
        },
        "chassisNumber": {
          "type": "string"
        },
        "loadStatus": {
          "type": "string",
          "enum": [
            "loaded",
            "empty"
          ]
        },
        "devanned": {
          "type": "boolean"
        },
        "location": {
          "type": "string",
          "maxLength": 64
        },
        "reason": {
          "type": "string",
          "maxLength": 500
        }
      },
      "required": [
        "containerVisitId",
        "action",
        "physicalConfirmed",
        "expectedUpdatedAt",
        "expectedChassis"
      ],
      "additionalProperties": true,
      "description": "mount requires chassisNumber; set_load_status requires loadStatus. devanned=true requires set_load_status/empty. Dates and equipment numbers are validated by the handler."
    }
  ]
}
EquipmentRename

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "visitId": {
          "type": "string",
          "format": "uuid"
        },
        "kind": {
          "type": "string",
          "enum": [
            "container",
            "chassis"
          ]
        },
        "expectedNumber": {
          "type": "string"
        },
        "newNumber": {
          "type": "string"
        },
        "reason": {
          "type": "string",
          "minLength": 5,
          "maxLength": 500
        },
        "physicalConfirmed": {
          "const": true
        }
      },
      "required": [
        "visitId",
        "kind",
        "expectedNumber",
        "newNumber",
        "reason",
        "physicalConfirmed"
      ],
      "additionalProperties": true
    }
  ]
}
EquipmentType

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "visitId": {
          "type": "string",
          "format": "uuid"
        },
        "expectedType": {
          "type": "string",
          "enum": [
            "chassis",
            "flatbed",
            "stepdeck",
            "lowboy"
          ]
        },
        "newType": {
          "type": "string",
          "enum": [
            "chassis",
            "flatbed",
            "stepdeck",
            "lowboy"
          ]
        },
        "reason": {
          "type": "string",
          "minLength": 5,
          "maxLength": 500
        },
        "physicalConfirmed": {
          "const": true
        }
      },
      "required": [
        "visitId",
        "expectedType",
        "newType",
        "reason",
        "physicalConfirmed"
      ],
      "additionalProperties": true
    }
  ]
}
ResponseCorrection

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "eventId": {
          "type": "string",
          "format": "uuid"
        },
        "expectedFingerprint": {
          "type": "string",
          "pattern": "^[a-fA-F0-9]{32}$"
        },
        "reason": {
          "type": "string",
          "minLength": 5,
          "maxLength": 500
        },
        "confirmed": {
          "const": true
        },
        "response": {
          "type": "object",
          "properties": {
            "direction": {
              "type": "string",
              "enum": [
                "inbound",
                "outbound"
              ]
            },
            "equipmentType": {
              "type": "string",
              "enum": [
                "bobtail",
                "chassis",
                "flatbed",
                "stepdeck",
                "container",
                "trailer"
              ]
            },
            "tractorNumber": {
              "type": "string"
            },
            "licensePlate": {
              "type": "string"
            },
            "driverName": {
              "type": "string"
            },
            "truckingCompany": {
              "type": "string"
            },
            "occurredAt": {
              "type": "string"
            }
          },
          "required": [
            "direction",
            "equipmentType",
            "occurredAt"
          ],
          "additionalProperties": true,
          "description": "Truck number or plate is required. Handler bounds text fields and validates observed time."
        }
      },
      "required": [
        "eventId",
        "expectedFingerprint",
        "reason",
        "confirmed",
        "response"
      ],
      "additionalProperties": true
    }
  ]
}
DockAssignment

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "visitId": {
          "type": "string",
          "format": "uuid"
        },
        "dockStatus": {
          "type": "string",
          "enum": [
            "waiting",
            "not_needed",
            "assigned"
          ]
        },
        "dock": {
          "type": "string"
        },
        "expectedDockStatus": {
          "type": "string",
          "enum": [
            "waiting",
            "not_needed",
            "assigned"
          ]
        },
        "expectedDock": {
          "type": "string"
        }
      },
      "required": [
        "visitId"
      ],
      "additionalProperties": true,
      "description": "dockStatus defaults to assigned when dock is supplied, otherwise waiting. assigned requires a valid dock; other statuses require an empty dock."
    }
  ]
}
Yardcheck

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "confirmOmissions": {
          "const": true
        },
        "reason": {
          "type": "string",
          "minLength": 5,
          "maxLength": 1000
        },
        "rows": {
          "type": "array",
          "maxItems": 2000,
          "items": {
            "type": "object",
            "properties": {
              "equipmentType": {
                "type": "string",
                "enum": [
                  "container",
                  "trailer",
                  "chassis",
                  "flatbed",
                  "stepdeck",
                  "lowboy"
                ]
              },
              "equipmentNumber": {
                "type": "string"
              },
              "supportNumber": {
                "type": "string"
              },
              "loadStatus": {
                "type": "string",
                "enum": [
                  "loaded",
                  "empty",
                  "unknown"
                ]
              },
              "location": {
                "type": "string",
                "maxLength": 64
              }
            },
            "required": [
              "equipmentType",
              "equipmentNumber"
            ],
            "additionalProperties": true,
            "description": "Container/trailer require loadStatus. Container alone may have supportNumber. Duplicate assets, duplicate supports and standalone mounted supports are rejected."
          }
        }
      },
      "required": [
        "confirmOmissions",
        "reason",
        "rows"
      ],
      "additionalProperties": true
    }
  ]
}
FacilityRequest
{
  "type": "object",
  "properties": {
    "facilityId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "facilityId"
  ],
  "additionalProperties": true
}
FacilityDisable

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "reason": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1000
        }
      },
      "required": [
        "reason"
      ],
      "additionalProperties": true
    }
  ]
}
FacilityProvision
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "code": {
      "type": "string",
      "pattern": "^[A-Z0-9][A-Z0-9-]{1,15}$"
    },
    "name": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "timezone": {
      "type": "string",
      "default": "America/Los_Angeles"
    },
    "referencePrefix": {
      "type": "string"
    },
    "spreadsheetId": {
      "type": "string"
    },
    "documentLibraryId": {
      "type": "string"
    }
  },
  "required": [
    "operationId",
    "code",
    "name",
    "referencePrefix",
    "spreadsheetId",
    "documentLibraryId"
  ],
  "additionalProperties": true
}
UserProvision
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "accessModel": {
      "const": "composable-v1"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "displayName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "currentEmail": {
      "type": "string",
      "format": "email"
    },
    "currentUserId": {
      "type": "string",
      "format": "uuid"
    },
    "assignments": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "object",
        "properties": {
          "roleKey": {
            "type": "string"
          }
        },
        "required": [
          "roleKey"
        ],
        "additionalProperties": true,
        "description": "Unique roleKey entries only; facilityId is rejected."
      }
    }
  },
  "required": [
    "operationId",
    "accessModel",
    "email",
    "displayName",
    "assignments"
  ],
  "additionalProperties": true,
  "description": "Email correction additionally requires currentEmail and currentUserId."
}
SheetMaintenance

References: #/components/schemas/Operation

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Operation"
    },
    {
      "type": "object",
      "properties": {
        "migrationKey": {
          "const": "annual-archive-v2"
        },
        "planToken": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "confirmation": {
          "const": "APPLY ANNUAL ARCHIVE STRUCTURE"
        }
      },
      "required": [
        "migrationKey",
        "planToken",
        "confirmation"
      ],
      "additionalProperties": true
    }
  ]
}
ArchiveVerification
{
  "type": "object",
  "properties": {
    "facilityId": {
      "type": "string",
      "format": "uuid"
    },
    "archiveId": {
      "type": "string",
      "format": "uuid"
    },
    "batchId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "facilityId",
    "archiveId",
    "batchId"
  ],
  "additionalProperties": true
}
AccessEdit

References: #/components/schemas/JsonValue

{
  "type": "object",
  "properties": {
    "accessModel": {
      "const": "composable-v1"
    },
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "expectedVersion": {
      "type": "string",
      "pattern": "^[a-f0-9]{32}$"
    },
    "reason": {
      "type": "string",
      "maxLength": 1000
    },
    "confirmation": {
      "type": "string"
    },
    "roleId": {
      "type": "string",
      "format": "uuid"
    },
    "userId": {
      "type": "string",
      "format": "uuid"
    },
    "definition": {
      "$ref": "#/components/schemas/JsonValue"
    },
    "assignments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "roleId"
        ],
        "additionalProperties": true
      }
    }
  },
  "required": [
    "accessModel",
    "operationId",
    "expectedVersion",
    "confirmation"
  ],
  "additionalProperties": true,
  "description": "Role save: SAVE ROLE CHANGES, optional roleId and RPC-validated definition. Assignment replacement: REPLACE USER ASSIGNMENTS, userId and assignments required; each assignment contains roleId and rejects facilityId."
}
PhotoUpload

References: #/components/schemas/PhotoCategory

{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "facilityId": {
      "type": "string",
      "format": "uuid"
    },
    "file": {
      "type": "string",
      "format": "binary",
      "description": "JPEG, PNG or WebP, Nonempty, up to 5 MiB, checked against file signature."
    },
    "category": {
      "$ref": "#/components/schemas/PhotoCategory",
      "default": "other"
    },
    "caption": {
      "type": "string",
      "maxLength": 240
    },
    "capturedAt": {
      "type": "string",
      "maxLength": 40
    }
  },
  "required": [
    "operationId",
    "facilityId",
    "file"
  ],
  "additionalProperties": true
}
QueuedPhoto
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "facilityId": {
      "type": "string",
      "format": "uuid"
    },
    "photoId": {
      "type": "string",
      "format": "uuid"
    },
    "file": {
      "type": "string",
      "format": "binary",
      "description": "Nonempty, up to 5 MiB. MIME, signature and SHA-256 must match the immutable photo manifest."
    }
  },
  "required": [
    "operationId",
    "facilityId",
    "photoId",
    "file"
  ],
  "additionalProperties": true
}
Facilities
{
  "type": "object",
  "properties": {
    "facilities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "spreadsheetConfigured": {
            "type": "boolean"
          },
          "driveConfigured": {
            "type": "boolean"
          },
          "canReconcile": {
            "type": "boolean"
          },
          "canYardcheck": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "code",
          "name",
          "canReconcile",
          "canYardcheck"
        ],
        "additionalProperties": true
      }
    }
  },
  "required": [
    "facilities"
  ],
  "additionalProperties": true
}
EquipmentState
{
  "type": "object",
  "properties": {
    "contractVersion": {
      "const": "equipment-state-v1"
    },
    "capabilities": {
      "type": "object",
      "properties": {
        "equipmentUpdate": {
          "type": "boolean"
        },
        "loadStatusUpdate": {
          "type": "boolean"
        },
        "equipmentCorrect": {
          "type": "boolean"
        }
      },
      "required": [
        "equipmentUpdate",
        "loadStatusUpdate",
        "equipmentCorrect"
      ],
      "additionalProperties": true
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "chassis": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    }
  },
  "required": [
    "contractVersion",
    "capabilities",
    "items",
    "chassis"
  ],
  "additionalProperties": true
}
ActiveVisits
{
  "type": "object",
  "properties": {
    "contractVersion": {
      "const": "gate-visits-v1"
    },
    "visitsReady": {
      "type": "boolean"
    },
    "capabilities": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "visitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "trucks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "trailers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "recentDepartures": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    }
  },
  "required": [
    "contractVersion",
    "visitsReady",
    "capabilities",
    "visitors",
    "trucks",
    "trailers",
    "recentDepartures"
  ],
  "additionalProperties": true
}
RecentMovements
{
  "type": "object",
  "properties": {
    "contractVersion": {
      "const": "recent-responses-v1"
    },
    "canEdit": {
      "type": "boolean"
    },
    "historyReady": {
      "type": "boolean"
    },
    "responsesReady": {
      "type": "boolean"
    },
    "historySource": {
      "type": "string",
      "enum": [
        "google-sheets",
        "supabase-fallback"
      ]
    },
    "liveReady": {
      "type": "boolean"
    },
    "syncPendingCount": {
      "type": "integer"
    },
    "responses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "pendingReconciliationsReady": {
      "const": false
    },
    "pendingReconciliations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    }
  },
  "required": [
    "contractVersion",
    "canEdit",
    "historyReady",
    "responsesReady",
    "historySource",
    "liveReady",
    "syncPendingCount",
    "responses",
    "pendingReconciliationsReady",
    "pendingReconciliations"
  ],
  "additionalProperties": true
}
PendingMovements
{
  "type": "object",
  "properties": {
    "contractVersion": {
      "const": "pending-reconciliations-v1"
    },
    "items": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "total": {
      "type": "integer",
      "minimum": 0
    },
    "snapshotSequence": {
      "type": "string",
      "pattern": "^[0-9]{1,19}$"
    },
    "pageCursor": {
      "type": "string"
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "contractVersion",
    "items",
    "total",
    "snapshotSequence",
    "pageCursor",
    "nextCursor"
  ],
  "additionalProperties": true,
  "description": "Cursor is opaque and bound to facility/snapshot; sequence is an int64 decimal string."
}
PhotoSearch
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "uploadedAt": {
            "type": "string"
          },
          "containerNumber": {
            "type": "string"
          },
          "chassisNumber": {
            "type": "string"
          },
          "driverName": {
            "type": "string"
          },
          "operationId": {
            "type": "string"
          },
          "driveUrl": {
            "type": "string",
            "format": "uri"
          }
        },
        "required": [
          "id",
          "name",
          "category",
          "containerNumber",
          "chassisNumber",
          "driverName",
          "operationId",
          "driveUrl"
        ],
        "additionalProperties": true
      }
    },
    "nextPageToken": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "items",
    "nextPageToken"
  ],
  "additionalProperties": true
}
Session
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "authenticated": {
          "const": false
        },
        "session": {
          "type": "null"
        }
      },
      "required": [
        "authenticated",
        "session"
      ],
      "additionalProperties": true
    },
    {
      "type": "object",
      "properties": {
        "authenticated": {
          "const": true
        },
        "authMode": {
          "type": "string"
        },
        "session": {
          "type": "object",
          "properties": {
            "user": {
              "type": "object",
              "additionalProperties": true,
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "email": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "id"
              ]
            },
            "jwt": {
              "type": "object",
              "properties": {
                "sub": {
                  "type": "string",
                  "format": "uuid"
                },
                "session_id": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "required": [
                "sub",
                "session_id"
              ],
              "additionalProperties": true
            },
            "source": {
              "const": "supabase"
            }
          },
          "required": [
            "user",
            "jwt",
            "source"
          ],
          "additionalProperties": true
        }
      },
      "required": [
        "authenticated",
        "authMode",
        "session"
      ],
      "additionalProperties": true
    }
  ]
}
WorkspaceApps
{
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        }
      },
      "required": [
        "email"
      ],
      "additionalProperties": true
    },
    "apps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "enum": [
              "admin",
              "schedule",
              "yms",
              "dashboard",
              "status",
              "api"
            ]
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "url"
        ],
        "additionalProperties": true
      }
    }
  },
  "required": [
    "user",
    "apps"
  ],
  "additionalProperties": true
}
ReconciliationResult
{
  "type": "object",
  "properties": {
    "applied": {
      "type": "integer"
    },
    "rejected": {
      "type": "integer"
    },
    "conflicts": {
      "type": "integer"
    },
    "skipped": {
      "type": "integer"
    },
    "remaining": {
      "type": "integer"
    },
    "pendingSync": {
      "type": "integer"
    }
  },
  "required": [
    "applied",
    "rejected",
    "conflicts",
    "skipped",
    "remaining",
    "pendingSync"
  ],
  "additionalProperties": true
}
PhotoReceipt

References: #/components/schemas/JsonValue

{
  "type": "object",
  "properties": {
    "photoId": {
      "type": "string",
      "format": "uuid"
    },
    "driveFileId": {
      "type": "string"
    },
    "sheetSync": {
      "$ref": "#/components/schemas/JsonValue"
    }
  },
  "required": [
    "photoId",
    "driveFileId",
    "sheetSync"
  ],
  "additionalProperties": true
}
MovementReceipt
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "sheetSync": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        }
      },
      "required": [
        "status"
      ],
      "additionalProperties": true
    }
  },
  "required": [
    "sheetSync"
  ],
  "additionalProperties": true,
  "description": "Additional durable receipt fields are supplied by the RPC. Accepted observation and downstream projection/synchronization are separate states."
}
AccessUsers
{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "const": 25
    },
    "total": {
      "type": "integer"
    },
    "hasNext": {
      "type": "boolean"
    },
    "loadedAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "users",
    "page",
    "pageSize",
    "total",
    "hasNext",
    "loadedAt"
  ],
  "additionalProperties": true
}
AccessRoles
{
  "type": "object",
  "properties": {
    "accessModel": {
      "type": "string",
      "enum": [
        "composable-v1",
        "legacy-scoped"
      ]
    },
    "facilities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "loadedAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "accessModel",
    "facilities",
    "roles",
    "permissions",
    "loadedAt"
  ],
  "additionalProperties": true
}
Health
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "misconfigured",
        "unhealthy",
        "degraded",
        "ok"
      ]
    },
    "checkedAt": {
      "type": "string"
    },
    "missing": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "integrations": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "required": [
    "status",
    "checkedAt",
    "missing",
    "checks",
    "integrations"
  ],
  "additionalProperties": true
}
AccessRoleEdit

References: #/components/schemas/AccessEdit

{
  "allOf": [
    {
      "$ref": "#/components/schemas/AccessEdit"
    },
    {
      "type": "object",
      "properties": {
        "confirmation": {
          "const": "SAVE ROLE CHANGES"
        }
      },
      "additionalProperties": true
    }
  ]
}
AccessAssignmentsEdit

References: #/components/schemas/AccessEdit

{
  "allOf": [
    {
      "$ref": "#/components/schemas/AccessEdit"
    },
    {
      "type": "object",
      "properties": {
        "confirmation": {
          "const": "REPLACE USER ASSIGNMENTS"
        },
        "userId": {
          "type": "string",
          "format": "uuid"
        },
        "assignments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "roleId": {
                "type": "string",
                "format": "uuid"
              }
            },
            "required": [
              "roleId"
            ],
            "additionalProperties": true
          }
        }
      },
      "required": [
        "userId",
        "assignments"
      ],
      "additionalProperties": true
    }
  ]
}
PublicHealth
{
  "type": "object",
  "properties": {
    "status": {
      "const": "ok"
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false
}
SessionRevocationRequest
{
  "type": "object",
  "properties": {
    "targetUserId": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "operationId": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    }
  },
  "required": [
    "targetUserId",
    "operationId"
  ],
  "additionalProperties": false,
  "description": "Exactly two UUIDs; normalized to lowercase. JSON request bound 4096 UTF-8 bytes. Reuse the same operationId and target after uncertain completion; authenticate each retry afresh."
}
SessionRevocationReceipt
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "targetUserId": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "status": {
      "const": "completed"
    },
    "recordedAt": {
      "type": "string",
      "format": "date-time"
    },
    "revokedSessionCount": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "operationId",
    "targetUserId",
    "status",
    "recordedAt",
    "revokedSessionCount"
  ],
  "additionalProperties": false
}
SessionRevocationCapability
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "additionalProperties": false
}
ApiReferenceHtml
{
  "type": "string",
  "description": "Self-contained, read-only HTML API reference with no scripts or external assets."
}
PublicOpenApiDocument
{
  "type": "object",
  "required": [
    "openapi",
    "info",
    "paths",
    "components"
  ],
  "properties": {
    "openapi": {
      "type": "string",
      "const": "3.1.1"
    },
    "info": {
      "type": "object"
    },
    "paths": {
      "type": "object"
    },
    "components": {
      "type": "object"
    }
  },
  "additionalProperties": true,
  "description": "Standard OpenAPI projection preserving local references and security while omitting internal review metadata. Public permission, facility-scope and alias extensions are retained."
}
FacilityCreate
{
  "type": "object",
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "code": {
      "type": "string",
      "pattern": "^[A-Z0-9][A-Z0-9-]{1,15}$"
    },
    "name": {
      "type": "string",
      "maxLength": 160
    },
    "address": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 500
    },
    "timezone": {
      "type": "string",
      "default": "America/Los_Angeles"
    },
    "referencePrefix": {
      "type": "string"
    },
    "spreadsheetId": {
      "type": "string"
    },
    "documentLibraryId": {
      "type": "string"
    },
    "operatingUnitType": {
      "type": "string",
      "enum": [
        "warehouse",
        "transport"
      ],
      "default": "warehouse"
    }
  },
  "required": [
    "operationId",
    "code",
    "name"
  ],
  "additionalProperties": false,
  "description": "Creates shared operating-unit metadata. Supplying any YMS field requires a warehouse and all three fields: referencePrefix, spreadsheetId, documentLibraryId. That workflow validates provider readiness before activation. Omitting all three creates an active master without YMS configuration. Stable code/type and external resource identities cannot be changed by metadata PATCH."
}
FacilityPatch
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "operationId",
    "expectedUpdatedAt",
    "changes"
  ],
  "properties": {
    "operationId": {
      "type": "string",
      "format": "uuid"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Exact updatedAt value from the management view. Stale writes return 409. Retry unchanged requests with the same operationId."
    },
    "changes": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 160
        },
        "address": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 500
        },
        "timezone": {
          "type": "string",
          "description": "Valid IANA timezone; also updates existing YMS settings."
        }
      }
    }
  }
}
ManagedFacility
{
  "type": "object",
  "required": [
    "id",
    "code",
    "name",
    "operatingUnitType",
    "active",
    "timezone",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "code": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "address": {
      "type": [
        "string",
        "null"
      ]
    },
    "operatingUnitType": {
      "type": "string",
      "enum": [
        "warehouse",
        "transport"
      ]
    },
    "active": {
      "type": "boolean"
    },
    "timezone": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "admin_only": {
      "type": "boolean"
    },
    "spreadsheetConfigured": {
      "type": "boolean"
    },
    "documentLibraryConfigured": {
      "type": "boolean"
    },
    "referencePrefix": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "additionalProperties": false
}

responses

Error

References: #/components/schemas/Error

{
  "description": "Failure; interpret HTTP status and stable code together. correlationId is in the JSON body.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
FacilitiesResponse

References: #/components/schemas/Success, #/components/schemas/Facilities

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/Facilities"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
EquipmentStateResponse

References: #/components/schemas/Success, #/components/schemas/EquipmentState

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/EquipmentState"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
JsonValueResponse

References: #/components/schemas/Success, #/components/schemas/JsonValue

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/JsonValue"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
MovementReceiptResponse

References: #/components/schemas/Success, #/components/schemas/MovementReceipt

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/MovementReceipt"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
ActiveVisitsResponse

References: #/components/schemas/Success, #/components/schemas/ActiveVisits

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/ActiveVisits"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
PendingMovementsResponse

References: #/components/schemas/Success, #/components/schemas/PendingMovements

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/PendingMovements"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
RecentMovementsResponse

References: #/components/schemas/Success, #/components/schemas/RecentMovements

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/RecentMovements"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
PhotoReceiptResponse

References: #/components/schemas/Success, #/components/schemas/PhotoReceipt

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/PhotoReceipt"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
PhotoSearchResponse

References: #/components/schemas/Success, #/components/schemas/PhotoSearch

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/PhotoSearch"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
ReconciliationResultResponse

References: #/components/schemas/Success, #/components/schemas/ReconciliationResult

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/ReconciliationResult"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
WorkspaceAppsResponse

References: #/components/schemas/Success, #/components/schemas/WorkspaceApps

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/WorkspaceApps"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
SessionResponse

References: #/components/schemas/Success, #/components/schemas/Session

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/Session"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  },
  "headers": {
    "Cache-Control": {
      "schema": {
        "type": "string"
      },
      "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
    }
  }
}
HealthResponse

References: #/components/schemas/Success, #/components/schemas/Health

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/Health"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    },
    "text/html": {
      "schema": {
        "type": "string"
      }
    }
  },
  "headers": {
    "Cache-Control": {
      "schema": {
        "type": "string"
      },
      "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
    },
    "X-Correlation-ID": {
      "description": "Present on HTML diagnostics; JSON correlationId is in the envelope.",
      "schema": {
        "type": "string"
      }
    }
  }
}
AccessUsersResponse

References: #/components/schemas/Success, #/components/schemas/AccessUsers

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/AccessUsers"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
AccessRolesResponse

References: #/components/schemas/Success, #/components/schemas/AccessRoles

{
  "description": "Existing success envelope; payload may include additional domain fields.",
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/AccessRoles"
              }
            },
            "required": [
              "body"
            ],
            "additionalProperties": true
          }
        ]
      }
    }
  }
}
PublicHealthResponse

References: #/components/schemas/Success, #/components/schemas/PublicHealth

{
  "description": "Public process liveness only; no dependency probes or readiness guarantee.",
  "headers": {
    "Cache-Control": {
      "schema": {
        "type": "string"
      },
      "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/PublicHealth"
              }
            },
            "required": [
              "body"
            ]
          }
        ]
      }
    }
  }
}
SessionRevocationResponse

References: #/components/schemas/Success, #/components/schemas/SessionRevocationReceipt

{
  "description": "Completed or replayed receipt; both return 200. No automatic mutation replay.",
  "headers": {
    "Cache-Control": {
      "schema": {
        "type": "string"
      },
      "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/SessionRevocationReceipt"
              }
            },
            "required": [
              "body"
            ]
          }
        ]
      }
    }
  }
}
SessionRevocationCapabilityResponse

References: #/components/schemas/Success, #/components/schemas/SessionRevocationCapability

{
  "description": "Capability state; boolean false by default. Provider uncertainty returns an error, never enabled=true.",
  "headers": {
    "Cache-Control": {
      "schema": {
        "type": "string"
      },
      "description": "private, no-store for session, revocation and protected diagnostics; no-store for public health."
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Success"
          },
          {
            "type": "object",
            "properties": {
              "body": {
                "$ref": "#/components/schemas/SessionRevocationCapability"
              }
            },
            "required": [
              "body"
            ]
          }
        ]
      }
    }
  }
}
FacilityListResponse

References: #/components/schemas/Facilities, #/components/schemas/ManagedFacility

{
  "description": "YMS facilities by default, or all managed operating units with service=admin. Administration view includes inactive units; external resource IDs are not returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "allowed",
          "body",
          "correlationId"
        ],
        "properties": {
          "allowed": {
            "const": true
          },
          "correlationId": {
            "type": "string"
          },
          "body": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Facilities"
              },
              {
                "type": "object",
                "required": [
                  "facilities"
                ],
                "properties": {
                  "facilities": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/ManagedFacility"
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}