PHphilterd
Contexts

Update a context's settings.

Changed on

Changes a context's entityTypeDisambiguation, disambiguationScope, and ledger settings, given in the body. Only the settings given change; one left out keeps its current value. Recorded as a context_updated audit event naming each setting that changed. Requires the contexts:write scope.

patch/api/contexts/{name}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/contexts/{name}
  • Auth
    HTTP bearer

Path parameters

namestring required

Query parameters

ownerstring

Headers

Authorizationstring required

Request body

disambiguationScope'document' | 'context'

Whether span disambiguation learns within each document (document) or across every document redacted in the context (context).

entityTypeDisambiguationboolean

Whether to apply entity-type span disambiguation.

ledgerboolean

Whether to record redactions in the ledger.

Response

The context was updated.

fieldstring

For a request refused as invalid, the parameter or body field that was invalid, when one is.

messagestring

What happened, written for a person to read. It may change; use reason in code.

reasonstring

For an error, why the request was refused, as a stable code a client can act on. The codes are listed in the API documentation under Errors.

Changes