HostingOptions

Get all hosting options with optional filtering

Changed on
get/api/v2/hosting-options

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

Query parameters

pagenumber

Numéro de page

pageSizenumber
Example:15

Nombre de résultats par page, 0 pour supprimer la pagination

sortBystring
Example:label

Champ utilisé pour le tri

order'asc' | 'desc'
Example:asc

Ordre de tri

searchstring

Recherche dans le fournisseur, la plateforme, le site, le bâtiment et la pièce

sitestring
platformstring
providerstring
buildingstring
roomstring

Response

Paginated list of hosting options

totalnumber required

Total number of items

Example response

{
  "results": [
    {
      "site": "CER(RENNES)",
      "platform": "PHYSIQUE",
      "provider": "DTNUM",
      "building": "B15",
      "room": "IT2",
      "id": "12345678-1234-1234-1234-123456789012",
      "hostingsCount": 3
    }
  ],
  "total": 100
}

Changes

  • e5a0ecc0d569Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      added the new optional query request parameter search

    • info

      added the required property // to the response with the status