Harbors

Describe Harbor Action

Changed on

Describe one granted operation and its currently available enabled fields.

Select an identity from List actions. Supply its connection_id, schema_id, and operation_id. Use a scoped credential belonging to this Harbor; description does not require write access.

effect identifies an operation as read_only or mutating. For read-only operations, lookup_fields and output_fields contain only fields both granted by the administrator and currently available through the Connection. input_fields is empty. Use Lookup action to return one projected record without preparation.

For mutations, input_fields contains only granted, currently available fields. lookup_fields and output_fields describe the connector's lookup and output. Fields retain their types, constraints, required flags, and nullability. Supply exactly one lookup when lookup_fields is nonempty; otherwise omit it. Omitted input fields remain unchanged. Explicit null requires nullable: true.

For mutations, idempotency describes remote deduplication, not permission to retry. Harbor write receipts remain metadata-only.

A provider discovery failure or a granted operation that is no longer available returns 503 Service Unavailable, not an empty field list. An ungranted identity returns 403 Forbidden. These responses do not revoke saved permissions. Polytomic checks current grants and provider capabilities again at execution.

Description fetches only the selected object's operations. It does not fetch fields for the entire catalog. Lookup permissions are checked against fresh provider metadata. Provider permissions and automation still apply.

Send a new nonzero UUID in X-Polytomic-Activity-Request-ID. A supplied X-Polytomic-Harbor-Session must be active and bound to this credential and Harbor. Successful description is recorded as action.listed.

get/api/harbors/{harbor_id}/actions/describe

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

harbor_idstring uuid required

Unique identifier of the Harbor

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

connection_idstring uuid required

Connection ID of the action

Example:248df4b7-aa70-47b8-a036-33ac447e668d
schema_idstring required

Schema ID of the action

operation_idstring required

Operation ID of the action

Headers

X-Polytomic-Versionstring
X-Polytomic-Harbor-Sessionstring

Harbor session token; when supplied, the session must be active and bound to this credential and Harbor.

X-Polytomic-Activity-Request-IDstring

New nonzero UUID for each request, required for scoped credentials; a reused value is rejected.

Response

OK

Changes

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the ///// response's property type changed from object to no type for status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status