actions.register-facility.invoke

POST

/v1/actions/register-facility

curl --request POST \
  --url https://example.com/v1/actions/register-facility \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "input": { "addressLine": "example", "city": "example", "facilityCode": "example", "jurisdiction": "example", "name": "example", "operatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "postalCode": "example" } }'

Authorizations

• bearerAuth

Parameters

Header Parameters

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Optional W3C trace context. Responses carry Registry trace context for the request.

Idempotency-Key

required

string

>= 1 characters <= 256 characters /^[\x21-\x2B\x2D-\x3A\x3C-\x7E]+$/

Idempotency key bound to the action route, selected profile, package revision, normalized action input, preconditions, and granted result contract.

Query Parameters

accessProfile

string

<= 128 characters

Select one compiled access profile. Required when the route has no default; otherwise omission uses its default.

Request Body^required

Media typeapplication/json

object

input

required

object

addressLine

required

string

>= 1 characters <= 240 characters

city

required

string

>= 1 characters <= 120 characters

facilityCode

required

string

>= 1 characters <= 64 characters

jurisdiction

required

string

>= 1 characters <= 40 characters

name

required

string

>= 1 characters <= 200 characters

operatorId

required

string format: uuid

postalCode

required

string

>= 1 characters <= 24 characters

Example ^generated

{
  "input": {
    "addressLine": "example",
    "city": "example",
    "facilityCode": "example",
    "jurisdiction": "example",
    "name": "example",
    "operatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "postalCode": "example"
  }
}

Responses

200

Immediate action committed

Media typeapplication/json

object

action

required

Allowed value: register-facility

applicationId

required

string format: uuid

results

required

object

assignment

required

object

recordId

required

string format: uuid

recordType

required

Allowed value: facility-assignment

revision

required

integer format: int64

>= 1

facility

required

object

recordId

required

string format: uuid

recordType

required

Allowed value: facility

revision

required

integer format: int64

>= 1

Example

{
  "action": "register-facility",
  "results": {
    "assignment": {
      "recordType": "facility-assignment"
    },
    "facility": {
      "recordType": "facility"
    }
  }
}

Headers

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this response.

Example

00-11111111111111111111111111111111-2222222222222222-01

400

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Examplerequest.invalid

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

401

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Exampleauthentication.refused

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

404

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Exampleresource.not_found

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

409

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

410

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Exampleidempotency.expired

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

412

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

{
  "code": "action.guard_failed",
  "detail": "The action guard was not satisfied.",
  "status": 412,
  "title": "Precondition Failed",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/action/guard_failed"
}

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

415

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Exampleunsupported.media_type

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

503

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

{
  "code": "runtime.field_encryption.unavailable",
  "detail": "The Registry field-encryption service is unavailable.",
  "status": 503,
  "title": "Service Unavailable",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/runtime/field_encryption/unavailable"
}

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

504

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Examplerequest.timeout

{
  "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

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01