HostingOptions

Update hosting option by ID

Changed on
patch/api/v2/hosting-options/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/auth, token URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/token)
    • API key in header x-refapp-token

Path parameters

idstring required

Request body

sitestring required

Site name (géographique)

platformstring required

Platform name

providerstring required

Provider name

buildingstring nullable

Building (optional)

roomstring nullable

Room (optional)

Example request

{
  "site": "CER(RENNES)",
  "platform": "PHYSIQUE",
  "provider": "DTNUM",
  "building": "B15",
  "room": "IT2"
}

Response

Hosting option updated successfully

sitestring required

Site name (géographique)

platformstring required

Platform name

providerstring required

Provider name

buildingstring nullable

Building (optional)

roomstring nullable

Room (optional)

idstring required

Unique identifier of the hosting option

Example response

{
  "site": "CER(RENNES)",
  "platform": "PHYSIQUE",
  "provider": "DTNUM",
  "building": "B15",
  "room": "IT2",
  "id": "12345678-1234-1234-1234-123456789012"
}

Changes

  • e5a0ecc0d569Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      the request property's maxLength was set to 100

    • warning

      the request property's maxLength was set to 100

    • warning

      the request property's maxLength was set to 100

    • warning

      the request property's maxLength was set to 50

    • warning

      the request property's maxLength was set to 100

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the non-success response with the status