/api/v1/reports/condition

POST

/api/v1/reports/condition

curl --request POST \
  --url https://example.com/api/v1/reports/condition \
  --header 'Content-Type: application/json' \
  --data '{ "reportId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "compareWith": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "include": { "photos": true }, "locale": "en", "digits": "western" }'

Request Body^required

Media typeapplication/json

object

reportId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

compareWith

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

include

object

photos

boolean

locale

string

Allowed values: en ar

digits

string

Allowed values: western eastern

Responses

202

Default Response

Media typeapplication/json

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

status

required

string

Allowed values: queued

expiresAt

required

string

Example

{
  "status": "queued"
}