Aller au contenu

Observer un élément de l'EDL

POST
/v1/inspections/{id}/items/{itemId}/observe
curl --request POST \
--url https://example.com/v1/inspections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/observe \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "observedCondition": "ok", "notes": "example", "numericValue": "example", "quantityExpected": 1, "quantityFound": 1, "photoRefs": [ "example" ] }'
id
required
string format: uuid
itemId
required
string format: uuid
Media type application/json
object
observedCondition
required
string
Allowed values: ok worn damaged missing dirty not_applicable
notes
string
nullable <= 2000 characters
numericValue
string
nullable <= 64 characters
quantityExpected
integer
nullable
quantityFound
integer
nullable
photoRefs
Array<string>
nullable <= 30 items

Observation enregistrée

Media type application/json
object
data
required
object
ok
required
boolean
Example
{
"data": {
"ok": true
}
}

Corps invalide

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
}

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
}

EDL ou élément 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
}