Aller au contenu

Détail d'un ordre de travail

GET
/v1/work-orders/{id}
curl --request GET \
--url https://example.com/v1/work-orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'X-API-Key: <X-API-Key>'
id
required
string format: uuid

Détail de l’ordre

Media type application/json
object
data
required
object
id
required
string format: uuid
establishmentId
required
string format: uuid
assetId
required
string format: uuid
unitId
string format: uuid
nullable
status
required
string
Allowed values: reported triaged assigned in_progress waiting_parts resolved verified closed cancelled
severity
required
string
Allowed values: minor major critical
impactOnAvailability
required
string
Allowed values: none ooo oos
assigneeUserId
string format: uuid
nullable
resolvedBy
string format: uuid
nullable
verifiedBy
string format: uuid
nullable
photoCount
required
integer
Example
{
"data": {
"status": "reported",
"severity": "minor",
"impactOnAvailability": "none"
}
}

Non authentifié

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Permission refusée

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Introuvable

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}