Renommer un poste

PATCH/v1/workstations/{workstation}

Droit de clé restreinte : workstations:write.

Paramètres de chemin

workstationtexteobligatoire
L'identifiant, ws_….

Corps de la requête

nametexteobligatoire
Le nom affiché du poste.

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend l’objet postes.

Une erreur suit le format commun.

Requête

curl


curl -X PATCH https://api.ophelix.fr/v1/workstations/ws_… \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Salle 2"}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->patch('/v1/workstations/ws_…', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'name' => 'Salle 2',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/workstations/ws_…', {
  method: 'PATCH',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    name: 'Salle 2'
  }),
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "workstation",
  "name": "Accueil",
  "platform": "macos",
  "os_version": null,
  "agent_version": "…",
  "agent_status": "up_to_date",
  "online": true,
  "status": "online",
  "readers": [
    {
      "name": "Accueil",
      "slots": [
        {
          "index": 0,
          "reader_name": "…",
          "card": null
        }
      ]
    }
  ],
  "last_seen_at": null,
  "state_reported_at": null,
  "last_card_at": null,
  "certificate_expires_at": null,
  "revoked_at": null,
  "created": 1793970000,
  "livemode": false
}