Transmittals
- GET
/rest/v1.0/transmittalsList visible project transmittals - POST
/rest/v1.0/transmittalsCreate a transmittal - GET
/rest/v1.0/transmittals/{id}Get a visible transmittal - PATCH
/rest/v1.0/transmittals/{id}Update a transmittal - DELETE
/rest/v1.0/transmittals/{id}Move a transmittal to the recycle bin - GET
/rest/v1.0/transmittals/{id}/items/{item_id}/downloadDownload transmittal item - PATCH
/rest/v1.0/transmittals/{id}/receiptsUpdate a current recipient receipt - POST
/rest/v1.0/transmittals/{id}/restoreRestore a recycled transmittal - PATCH
/rest/v1.0/transmittals/{id}/restoreRestore a recycled transmittal - POST
/rest/v1.0/transmittals/create_fromCreate a transmittal from documents or drawings - GET
/rest/v1.0/transmittals/recycle_binList recycled project transmittals
/rest/v1.0/transmittalsList visible project transmittals
Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- project_idintegerqueryrequired
- pageintegerquery
- per_pageintegerquery
- searchstringquery
- sortstringqueryOne of: number, -number, date, -date, created_at, -created_at.
- filters[id]stringqueryComma-separated filter values
- filters[sent_via]stringqueryComma-separated filter values
- filters[submitted_for]stringqueryComma-separated filter values
- filters[from_id]stringqueryComma-separated filter values
- filters[search]stringqueryComma-separated filter values
Response · 200 · object[]
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X GET "https://app.os.construction/rest/v1.0/transmittals" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/transmittalsCreate a transmittal
Creates a transmittal. deliver=true queues recipient email notifications and requires a UUID submission_key plus at least one recipient. Referenced documents/drawings require their corresponding source permissions. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- project_idintegerqueryrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- transmittalobjectrequired
- transmittal.numberstring
- transmittal.subjectstringrequired
- transmittal.datestring | null
- transmittal.to_idsinteger[]
- transmittal.cc_idsinteger[]
- transmittal.sent_viastring | nullOne of: attached, under_separate_cover.
- transmittal.privateboolean
- transmittal.submitted_forstring | nullOne of: approval, your_use, as_requested, review_and_comment, further_processing.
- transmittal.actionsstring[]One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- transmittal.due_by_datestring | null
- transmittal.sent_datestring | null
- transmittal.remarksstring | null
- transmittal.itemsobject[]
- transmittal.items[].idinteger
- transmittal.items[].document_version_idinteger
- transmittal.items[].drawing_revision_idinteger
- transmittal.items[].source_upload_idany
- transmittal.items[].sourceUploadIdany
- transmittal.items[].source_revision_labelany
- transmittal.items[].sourceRevisionLabelany
- transmittal.items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- transmittal.items[].descriptionstring
- transmittal.items[].datestring | null
- transmittal.items[].quantityinteger | null
- transmittal.items[].notesstring | null
- transmittal.items[].item_typestringOne of: freeform, document, drawing.
- transmittal.items[].ref_idinteger | null
- transmittal.deliverboolean
- transmittal.submission_keystring (uuid)
Response · 201 · object
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X POST "https://app.os.construction/rest/v1.0/transmittals" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"transmittal": {
"subject": "string"
}
}'/rest/v1.0/transmittals/{id}Get a visible transmittal
Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- idintegerpathrequired
- project_idintegerquery
Response · 200 · object
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X GET "https://app.os.construction/rest/v1.0/transmittals/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/transmittals/{id}Update a transmittal
Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- idintegerpathrequired
- project_idintegerquery
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- transmittalobjectrequired
- transmittal.numberstring
- transmittal.subjectstring
- transmittal.datestring | null
- transmittal.to_idsinteger[]
- transmittal.cc_idsinteger[]
- transmittal.sent_viastring | nullOne of: attached, under_separate_cover.
- transmittal.privateboolean
- transmittal.submitted_forstring | nullOne of: approval, your_use, as_requested, review_and_comment, further_processing.
- transmittal.actionsstring[]One of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- transmittal.due_by_datestring | null
- transmittal.sent_datestring | null
- transmittal.remarksstring | null
- transmittal.itemsobject[]
- transmittal.items[].idinteger
- transmittal.items[].document_version_idinteger
- transmittal.items[].drawing_revision_idinteger
- transmittal.items[].source_upload_idany
- transmittal.items[].sourceUploadIdany
- transmittal.items[].source_revision_labelany
- transmittal.items[].sourceRevisionLabelany
- transmittal.items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- transmittal.items[].descriptionstring
- transmittal.items[].datestring | null
- transmittal.items[].quantityinteger | null
- transmittal.items[].notesstring | null
- transmittal.items[].item_typestringOne of: freeform, document, drawing.
- transmittal.items[].ref_idinteger | null
Response · 200 · object
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X PATCH "https://app.os.construction/rest/v1.0/transmittals/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"transmittal": {}
}'/rest/v1.0/transmittals/{id}Move a transmittal to the recycle bin
Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- idintegerpathrequired
- project_idintegerquery
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Response · 204
No response body.
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X DELETE "https://app.os.construction/rest/v1.0/transmittals/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)"/rest/v1.0/transmittals/{id}/items/{item_id}/downloadDownload transmittal item
Parameters
- idintegerpathrequired
- item_idintegerpathrequired
Response · 200 · object
No documented fields.
Errors
401Missing, invalid or expired API token.403The token or user lacks the required scope or permission.404The record does not exist or belongs to another company.
Example request
curl -X GET "https://app.os.construction/rest/v1.0/transmittals/1/items/1/download" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/transmittals/{id}/receiptsUpdate a current recipient receipt
Requires a current recipient. The authenticated user may update their own receipt; project transmittals administrators may update other recipient receipts. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- idintegerpathrequired
- project_idintegerquery
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- user_idintegerrequired
- receivedboolean
- acknowledgedboolean
Response · 200 · object
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X PATCH "https://app.os.construction/rest/v1.0/transmittals/1/receipts" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"user_id": 1
}'/rest/v1.0/transmittals/{id}/restoreRestore a recycled transmittal
Requires the project transmittals delete permission. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- idintegerpathrequired
- project_idintegerquery
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Response · 200 · object
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X POST "https://app.os.construction/rest/v1.0/transmittals/1/restore" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)"/rest/v1.0/transmittals/{id}/restoreRestore a recycled transmittal
Requires the project transmittals delete permission. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- idintegerpathrequired
- project_idintegerquery
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Response · 200 · object
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X PATCH "https://app.os.construction/rest/v1.0/transmittals/1/restore" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)"/rest/v1.0/transmittals/create_fromCreate a transmittal from documents or drawings
Creates a transmittal. deliver=true queues recipient email notifications and requires a UUID submission_key plus at least one recipient. Referenced documents/drawings require their corresponding source permissions. Select at least one document or drawing. Version selection arrays must match the corresponding IDs in length. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- project_idintegerqueryrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- transmittalobjectrequired
- transmittal.document_idsanyrequired
Response · 201 · object
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X POST "https://app.os.construction/rest/v1.0/transmittals/create_from" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"transmittal": {
"document_ids": null
}
}'/rest/v1.0/transmittals/recycle_binList recycled project transmittals
Requires the project transmittals delete permission even though this operation is read only. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.
Parameters
- project_idintegerqueryrequired
- pageintegerquery
- per_pageintegerquery
Response · 200 · object[]
- idintegerrequired
- numberstringrequired
- subjectstring | nullrequired
- datestring | nullrequired
- toobject[]required
- to[].idintegerrequired
- to[].loginstringrequired
- to[].namestringrequired
- ccobject[]required
- cc[].idintegerrequired
- cc[].loginstringrequired
- cc[].namestringrequired
- fromnull | objectrequired
- from.idintegerrequired
- from.loginstringrequired
- from.namestringrequired
- sent_viaanyrequiredOne of: attached, under_separate_cover, null.
- privatebooleanrequired
- submitted_foranyrequiredOne of: approval, your_use, as_requested, review_and_comment, further_processing, null.
- actionsobject[]required
- actions[].actionstringrequiredOne of: out_for_signature, approved_as_submitted, approved_as_noted, submit, resubmitted, returned, returned_for_corrections, resubmit, due_by, received, received_as_noted, sent_date.
- actions[].datestring | nullrequired
- remarksstring | nullrequired
- statusanyrequiredOne of: sent, delivered.
- delivered_datestring | nullrequired
- email_recorded_atstring | nullrequired
- itemsobject[]required
- items[].idintegerrequired
- items[].formatstringrequiredOne of: Attic Stock, CDs, Commitment Contract, Communication, Document, Other, Plans, Potential Change Order, Prime Contract, Prints, Punch List Item, Purchase Order Contract, RFI, Samples, Shop Drawings, Submittal Log, Submittal Package.
- items[].descriptionstringrequired
- items[].datestring | nullrequired
- items[].quantityinteger | nullrequired
- items[].notesstring | nullrequired
- items[].item_typestringrequiredOne of: freeform, document, drawing.
- items[].ref_idinteger | nullrequired
- items[].refnull | objectrequired
- items[].document_version_idinteger | nullrequired
- items[].drawing_revision_idinteger | nullrequired
- items[].source_upload_idinteger | nullrequired
- items[].source_revision_labelstring | nullrequired
- created_bynull | objectrequired
- created_by.idintegerrequired
- created_by.loginstringrequired
- created_by.namestringrequired
- created_atstringrequired
- updated_atstringrequired
- receiptsobject[]required
- receipts[].usernull | objectrequired
- receipts[].receivedbooleanrequired
- receipts[].received_atstring | nullrequired
- receipts[].acknowledgedbooleanrequired
Errors
401Authentication required403Permission denied404Record unavailable in the authorized project422Invalid request or business validation failure
Example request
curl -X GET "https://app.os.construction/rest/v1.0/transmittals/recycle_bin" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"