latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility

Associate a 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. Supports three request shapes, each with different conflict behavior: (1) legacy single networkId — always upserts the TenantGroupFacilityNetwork relationship with no pre-check, silently updating an existing association rather than rejecting it; (2) bulk networkIds or (3) grouped networkAssociations — both explicitly check for an existing active association per facility-network and per facility-location-network pair first, and return 409 Conflict if one already exists rather than silently updating it. Choose the bulk/grouped shapes when you need to detect pre-existing associations instead of upserting over them.

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

Single network ID (legacy). Mutually exclusive with networkIds.

networkIdsstring[]

Bulk network IDs (CP-32346). Mutually exclusive with networkId.

includeAllActiveFacilityLocationsboolean

When true, associate all active facility locations under the facility/group

facilityLocationIdsstring[]

Certify location IDs to associate (optional when includeAllActiveFacilityLocations is true)

networkEffectiveDatestring

Effective date for facility and location network associations

groupEffectiveDatestring

Effective date for the TenantGroupFacility relationship

legacySingleNetworkRequestboolean
groupedNetworkRequestboolean
bulkNetworkRequestboolean
networkInputValidboolean

Example request

{
  "groupId": "group-123",
  "networkId": "network-456",
  "networkIds": [
    "network-456",
    "network-789"
  ],
  "facilityLocationIds": [
    "loc-1",
    "loc-2"
  ],
  "networkEffectiveDate": "2026-04-01",
  "groupEffectiveDate": "2026-03-15",
  "networkAssociations": [
    {
      "networkId": "network-456",
      "effectiveDate": "2026-04-01"
    }
  ]
}

Response

Successfully associated facility with network

tenantGroupFacilityIdstring

ID of the tenant group facility

tenantGroupFacilityNetworkIdstring

ID of the tenant group facility network association (legacy / first network)

networkIdstring

ID of the network that was associated (legacy / first network)

statusstring

Indicates the result of the association

facilityNetworkCountinteger

Number of facility-network associations created or updated

locationNetworkCountinteger

Number of facility-location-network associations created

Example response

{
  "tenantGroupFacilityId": "tgf-456",
  "tenantGroupFacilityNetworkId": "tgfn-789",
  "networkId": "net-123",
  "status": "created",
  "facilityNetworkCount": 2,
  "locationNetworkCount": 4,
  "associations": [
    {
      "networkId": "net-123",
      "tenantGroupFacilityNetworkId": "tgfn-789",
      "tenantGroupLocationFacilityNetworkIds": [
        "tglfn-1"
      ]
    }
  ]
}