action contract_p_post_document_status_data_resource { label: "Update document status" description: "Update the given document status data with the request user and date.\n\nEach document defines some status:\n- lock\n- escalate\n- reject\n- delete\n- archive\n- submitted\n\nThese fields have 3 attributes:\n- status true / false\n- since: datetime (UTC)\n- by: user ID\n\nBy calling this endpoint you can update the given status data with the request user\n(the one authenticated) and the current datetime.\n**Note** : You cannot pass a user in the request nor a datetime\n\n**Permission required:** review" provider: contract_p method: POST path: "/documents/{document_id}/status_data" encoding: json input: { type: "object" properties: { "X-Fields": { type: "string" format: "mask" } escalate: { type: "object" properties: { by: { type: "string" } since: { type: "string" format: "date-time" } value: { type: "boolean" } } } last_version: { type: "string" } lock: { type: "object" additionalProperties: true } opened_by: { type: "object" additionalProperties: true } reject: { type: "object" additionalProperties: true } status_data: { type: "object" properties: { archived: { type: "boolean" } data: { type: "boolean" } escalate: { type: "boolean" } feedback: { type: "boolean" } lock: { type: "boolean" } ready_accepted: { type: "boolean" } ready_attempts: { type: "integer" } reject: { type: "boolean" } reject_accepted: { type: "boolean" } reject_attempts: { type: "integer" } sampling: { type: "boolean" } submit_accepted: { type: "boolean" } submit_attempts: { type: "integer" } success: { type: "boolean" } } } submitted: { type: "object" additionalProperties: true } timings: { type: "object" properties: { done_time: { type: "string" format: "date-time" } feedback_time: { type: "string" format: "date-time" } processing_period: { type: "number" } receive_time: { type: "string" format: "date-time" } start_time: { type: "string" format: "date-time" } submit_time: { type: "string" format: "date-time" } } } } additionalProperties: false } output: { type: "object" required: ["id", "inbox", "original_filename", "page_count"] properties: { escalate: { type: "object" properties: { by: { type: "string" } since: { type: "string" format: "date-time" } value: { type: "boolean" } } } feedback: { type: "object" } files: { type: "array" items: { type: "object" properties: { embedded_attachment: { type: "boolean" } filehash: { type: "string" } filename: { type: "string" } leaf: { type: "boolean" } page: { type: "integer" } page_count: { type: "integer" } } } } flag_for_review: { type: "boolean" } id: { type: "string" } inbox: { type: "string" } last_version: { type: "string" } lock: { type: "object" additionalProperties: true } meta_information: { type: "object" } opened_by: { type: "array" items: { type: "object" additionalProperties: true } } original_filename: { type: "string" } page_count: { type: "integer" } prediction: { type: "object" } reject: { type: "object" additionalProperties: true } status_data: { type: "object" properties: { archived: { type: "boolean" } data: { type: "boolean" } escalate: { type: "boolean" } feedback: { type: "boolean" } lock: { type: "boolean" } ready_accepted: { type: "boolean" } ready_attempts: { type: "integer" } reject: { type: "boolean" } reject_accepted: { type: "boolean" } reject_attempts: { type: "integer" } sampling: { type: "boolean" } submit_accepted: { type: "boolean" } submit_attempts: { type: "integer" } success: { type: "boolean" } } } submitted: { type: "object" additionalProperties: true } timings: { type: "object" properties: { done_time: { type: "string" format: "date-time" } feedback_time: { type: "string" format: "date-time" } processing_period: { type: "number" } receive_time: { type: "string" format: "date-time" } start_time: { type: "string" format: "date-time" } submit_time: { type: "string" format: "date-time" } } } usage_data: { type: "object" } versions: { type: "array" items: { type: "object" } } } } }