Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Facility

Associate facility with a network

Associates a facility with a network following the roster ingestion pattern. The network must belong to a group (groupId provided in request body). If the facility is not associated with the group, the group association will also be created simultaneously. Validates that the network belongs to the specified group before creating the association. Creates or updates a TenantGroupFacilityNetwork relationship.

post/facilities/{id}/networks

Path parameters

idstring required

ID of the facility (certify facility ID)

Headers

tenant-idstring

Request body

groupIdstring required

ID of the group that the network belongs to

networkIdstring required

ID of the network to associate with

networkEffectiveDatestring

Effective date for the facility-network association

groupEffectiveDatestring

Effective date for the TenantGroupFacility relationship

Example request

{
  "groupId": "group-123",
  "networkId": "network-456",
  "networkEffectiveDate": "2026-04-01",
  "groupEffectiveDate": "2026-03-15"
}

Response

Successfully associated facility with network

tenantGroupFacilityIdstring

ID of the tenant group facility

tenantGroupFacilityNetworkIdstring

ID of the tenant group facility network association

networkIdstring

ID of the network that was associated

statusstring

Indicates the result of the association

Example response

{
  "tenantGroupFacilityId": "tgf-456",
  "tenantGroupFacilityNetworkId": "tgfn-789",
  "networkId": "net-123",
  "status": "created"
}