Skip to content
docstack-ocr

Override Review Endpoint

POST
/v1/reviews/{review_id}/override
 
curl --request POST \
  --url http://localhost:8080/v1/reviews/example/override \
  --header 'Content-Type: application/json' \
  --data '{ "patch": {}, "note": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
review_id
required
Review Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
OverridePayload
object
patch
Patch
object
key
additional properties
any
note
Any of:
string
Example generated
{
  "patch": {},
  "note": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
ReviewDetailResponse
object
review
required
ReviewSummary
object
review_id
required
Review Id
string
job_id
required
Job Id
string
job_status
required
Job Status
string
batch_id
required
Any of:
string
original_filename
Any of:
string
status
required
Status
string
Allowed values: pending in_review approved overridden reprocessed closed_by_delete
reasons
required
Reasons
Array<string>
created_at
required
Created At
string
updated_at
required
Updated At
string
resolved_at
required
Any of:
string
resolved_by
required
Any of:
string
resolution
required
Any of:
string
resolution_note
required
Any of:
string
job
required
Job
object
key
additional properties
any
Example 
{
  "review": {
    "status": "pending"
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}