Sign in
knowledge-base-governance

Update a version's lifecycle governance status / expiry

patch/v1/knowledge-base/documents/{doc_id}/versions/{version_id}/governance

Path parameters

doc_idstring uuid required
version_idstring uuid required

Request body

governance_status'active' | 'retired' | 'suppressed' | 'manual_hold' | 'expired' nullable
expires_atstring date-time nullable
reason_codestring nullable
notestring nullable
idempotency_keystring nullable

Response

Successful Response

idstring uuid required
document_idstring uuid required
knowledge_base_idstring uuid required
version_numberinteger required
statestring required
scan_statusstring required
governance_statusstring required
expires_atstring date-time nullable
governance_reason_codestring nullable
governance_notestring nullable
governance_updated_bystring uuid nullable
governance_updated_atstring date-time nullable
governance_policy_versionstring nullable
effective_serving_statusstring required

Changes

Changed in 1 of the 3 revisions of this API.6

  • 5a5597ebb2d66See the full diff
    • ○

      added the optional property retry_after to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 404 status

      response-optional-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog