Required Documents

Working with Required Documents

Required Documents are a new type of attachment introduced to support Schedules and Work Orders created from Work Order Schedules in Corrigo Enterprise. This feature gives Requestors the ability to define and dictate what attachments should be uploaded to better support routine Work Order documentation in their Corrigo environment.
Required Documents in schedules are the equivalent of filing cabinet drawers, each dedicated to a single document. For instance, a schedule could have a Required Document drawer configured for Fire Sprinkler Inspection Checklist, Elevator Inspection Certificate, or even a Photographic Proof of Work Done. A schedule could have one or more of such filing cabinet drawers, all appropriate to the work managed by the schedule.
Work Orders created from the schedule will automatically have the same Required Document configurations as well. To carry the simile further, the Work Order’s Required Documents will be the equivalent of empty file folders for each of the drawers in the schedule. It will be the responsibility of those working on the Work Order to upload the appropriate file/photo to the waiting file folder.

Retrieving Required Documents

You can retrieve a list of Required Documents and related data associated with a work order.
To retrieve the list of Required Documents, call GET/api/requiredDocument

Getting a link to a Required Document

You can obtain a temporary link to a file attached to a required document by the call GET/api/requiredDocument/downloadUrl

Warning: You can download the attached file from the obtained URL within 15 minutes after the link is provided. DO NOT SAVE THIS LINK!

Adding attachment to Required Document entry

To satisfy the Required Document condition of a work order, you must add the appropriate attachment to the Required Document entity. To add an attachment/document and related information to the entity call POST/api/requiredDocument

Warning: This is a separate entity and endpoint from general work order documents/attachments. Use this method ONLY for the Required Document entity and ONLY if the work order has a list of Required Documents found with the GET function.

Deleting attachments from a Required Document

You can delete the attachment/document from within a Required Document record if you need to revoke, replace, or just clear the contents for any reason. To do this call DELETE/api/requiredDocument

Updating attachment data on a Required Document

You can amend data associated with an attachment on a Required Document, such as file details, name, and description if the file attached is correct but the data is not. To update attachment information on a Required Document call PUT/api/requiredDocument

Required Document info changed event notification
Every time the RequiredDocument info is changed, your WebHook receives a notification containing the updated information.

Fields

📘

Example notification: Required Document info changed

JSON
{
"DocumentId": 721,
"StartDate": null,
"EndDate": null,
"DocumentDate": "2024-11-27T00:00:00",
"Description": "Required Documents should conation all details about work done on work order, thanks.",
"HasAdditionalWork": false,
"Status": "Reviewed",
"Attachment": {
"AttachmentId": "da76671c-10b8-477d-a977-0504ada0438a",
"Name": "sample.pdf",
"MimeType": "application/pdf",
"Size": 18810,
"SentAt": "2024-11-27T10:05:22.41Z",
"DocumentType": "Misc",
"Title": "sample",
"Visibility": "All",
"SenderName": "Ashvini Damawale"
},
"Header": {
"WorkOrderId": 4514352,
"BranchId": 300621,
"Sender": {
"Name": "System Administrator",
"Phone": null,
"Type": "Customer"
},
"Action": "RequiredDocumentUpdated",
"ActionDate": "2024-11-27T10:05:59.0856976Z",
"ApiVersion": "1.2",
"MessageId": "c19df8fa-e855-4120-a7de-bd3657d37c38"
}
}

Status
The following table describes the available status of required document: