latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility

List TGFL-anchored location associations for a facility

Returns a paginated list of all tenant_group_facility_locations (TGFL) associations for the given facility. Each item in data[] contains the TGFL anchor row plus flat sibling entities: tenantGroupFacility, tenantFacility, tenantGroup, tenantGroupLocation, groupLocation, locationEntityAddresses, and tenantGroupLocationFacilityNetworks (TGLFN). All entity foreign-key references are wrapped as objects ({id, data}) to allow future schema evolution without breaking consumers. certifyGroupId: restrict to TGFLs whose group resolves to this certify group id. networkId: restrict to TGFLs that have a matching TGLFN row for this network id (EXISTS semantics — TGFL rows are never duplicated); the TGLFN array on each item is also filtered to the requested network when set. locationSearch: restrict to TGFLs whose resolved location name contains this text (case-insensitive substring match). Blank/omitted = no filter. Note: operationId retains the legacy plural form for OpenAPI stability; the Java method is getFacilityLocationRelationships.

get/facilities/{id}/relationships/locations

Path parameters

idstring required

Certify facility id. Maps to the OV entityId (certify_facility_id).

Query parameters

certifyGroupIdstring

Filter by certify group id. Only TGFLs whose group resolves to this id are returned. Omit to include all groups.

locationSearchstring

Filter by location name (case-insensitive substring match against the resolved location name). Omit/blank to include all locations.

networkIdstring

Filter by network id. Only TGFLs that have a matching TGLFN row for this network id are returned (EXISTS semantics — TGFL rows are never duplicated). The tenantGroupLocationFacilityNetworks array on each item is also filtered to this network when set. Omit to include all networks.

pageinteger

Page number (0-based), for offset-based pagination. Default: 0.

sizeinteger

Page size (clamped to max 100). Default: 50.

Headers

tenant-idstring required

Tenant ID

Response

Paginated TGFL location associations successfully retrieved.

totalCountinteger

Total number of matching TGFL records (across all pages).