Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.43.0.
records.operator.patch
const url = 'https://example.com/v1/records/operators/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: { 'Idempotency-Key': 'example', 'If-Match': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json' }, body: '[ { "op": "add", "path": "example", "value": "example" } ]'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/v1/records/operators/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json-patch+json' \ --header 'Idempotency-Key: example' \ --header 'If-Match: example' \ --data '[ { "op": "add", "path": "example", "value": "example" } ]'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Canonical record UUID.
Header Parameters
Section titled “Header Parameters”Optional W3C trace context. Responses carry Registry trace context for the request.
Idempotency key bound to method, route, caller, target record, package revision, request body, and response field set.
Strong Registry ETag for the currently visible record representation.
Query Parameters
Section titled “Query Parameters”Select one compiled access profile. Required when the route has no default; otherwise omission uses its default.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Responses
Section titled “Responses”Record patched
object
object
object
object
Example
{ "data": { "domainData": { "status": "active" } }, "meta": { "datasetIdentifier": "facility-registry", "entityTypeIdentifier": "operator", "registryIdentifier": "facility-registry" }}object
object
object
object
Example
{ "@context": "https://id.registrystack.org/contexts/registry-record/v1", "data": { "domainData": { "status": "active" } }, "meta": { "datasetIdentifier": "facility-registry", "entityTypeIdentifier": "operator", "registryIdentifier": "facility-registry" }}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Strong Registry ETag bound to the record, package revision, caller profile, and response field set.
Example
<https://id.registrystack.org/profiles/registry-record/v1>; rel="profile", </v1/schemas/operator>; rel="describedby"Emitted only for application/json and application/ld+json Registry Record responses and omitted for application/geo+json. Carries the Registry Record profile and caller-visible record type schema. The describedby target includes the configured deployment prefix and is never derived from Host or forwarded headers.
Responses vary by authorization and negotiated representation.
Trace context for this response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "request.invalid", "detail": "The request is invalid.", "status": 400, "title": "Bad Request", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/request/invalid"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "authentication.refused", "detail": "The bearer credential is missing or refused.", "status": 401, "title": "Unauthorized", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/authentication/refused"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "resource.not_found", "detail": "The requested resource was not found.", "status": 404, "title": "Not Found", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/resource/not_found"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "idempotency.conflict", "detail": "The idempotency key is bound to another request.", "status": 409, "title": "Conflict", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/idempotency/conflict"}{ "code": "mutation.conflict", "detail": "The mutation conflicts with current state.", "status": 409, "title": "Conflict", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/mutation/conflict"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "idempotency.expired", "detail": "The held response of the idempotency key expired; the key stays spent.", "status": 410, "title": "Gone", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/idempotency/expired"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "precondition.failed", "detail": "The mutation precondition failed.", "status": 412, "title": "Precondition Failed", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/precondition/failed"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "unsupported.media_type", "detail": "The request media type is not supported.", "status": 415, "title": "Unsupported Media Type", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/unsupported/media_type"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "precondition.required", "detail": "The mutation precondition is required.", "status": 428, "title": "Precondition Required", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/precondition/required"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "service.unavailable", "detail": "The Registry mutation service is unavailable.", "status": 503, "title": "Service Unavailable", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/service/unavailable"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01Problem response
object
Examples
{ "code": "request.timeout", "detail": "The request timed out.", "status": 504, "title": "Gateway Timeout", "traceId": "11111111111111111111111111111111", "type": "https://id.registrystack.org/problems/registry-breg/request/timeout"}Headers
Section titled “Headers”Caller-dependent responses must not be stored.
Trace context for this problem response.
Example
00-11111111111111111111111111111111-2222222222222222-01