Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Facility

Update a tenant facility specialty record

Updates a TenantFacilitySpecialty record (Level 1) by replacing the tenant_specialty_id, updating the effective date, or both. At least one of newTenantSpecialtyId or effectiveDate must be provided. Does not trigger termination events or lifecycle changes.

patch/facilities/tenant-facility-specialties/specialty

Headers

tenant-idstring

Request body

tenantFacilitySpecialtyIdstring required

ID of the existing TenantFacilitySpecialty record to update

newTenantSpecialtyIdstring

ID of the new TenantSpecialty to replace the current one. Optional if effectiveDate or isPrimary is provided.

effectiveDatestring

New effective date for the specialty record in ISO format (YYYY-MM-DD). Optional if newTenantSpecialtyId or isPrimary is provided.

isPrimaryboolean

Whether this specialty should be marked as primary. Optional if newTenantSpecialtyId or effectiveDate is provided.

changeReasonstring

Optional human-readable reason for the change, captured for audit trail.

Example request

{
  "tenantFacilitySpecialtyId": "tfs_abc123",
  "newTenantSpecialtyId": "ts_xyz789",
  "effectiveDate": "2026-01-15",
  "isPrimary": true,
  "changeReason": "Correcting specialty mapping per annual review"
}

Response

Specialty updated successfully

emptyboolean
valueNodeboolean
containerNodeboolean
missingNodeboolean
arrayboolean
objectboolean
nodeType'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
pojoboolean
numberboolean
integralNumberboolean
floatingPointNumberboolean
shortboolean
intboolean
longboolean
floatboolean
doubleboolean
bigDecimalboolean
bigIntegerboolean
textualboolean
booleanboolean
nullboolean
binaryboolean