Skip to content

Commit f227148

Browse files
authored
DOCINT-1905: Document v2.1 bulk-create revisions in the PDM guide. (#377)
Retarget Step 8 to the shipped v2.1 path so integrators use ids + failures. Use a {version} placeholder on the Document Management base path.
1 parent e8b8770 commit f227148

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

‎document_management_integration/document_management_technical_guide.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ The sandbox environment is a safe place to iterate on requests and validate resp
3030
All V2 Document Management endpoints use the following base path:
3131

3232
```
33-
/rest/v2.0/companies/{company_id}/projects/{project_id}/document_management
33+
/rest/v{version}/companies/{company_id}/projects/{project_id}/document_management
3434
```
3535

36-
Replace `{company_id}` and `{project_id}` with your actual Procore company and project IDs.
36+
Replace `{version}` with the version shown in each step (`2.0` or `2.1`). Replace `{company_id}` and `{project_id}` with your actual Procore company and project IDs.
3737

3838
### Workflow Summary
3939

@@ -46,7 +46,7 @@ Replace `{company_id}` and `{project_id}` with your actual Procore company and p
4646
| 5 | `/rest/v2.1/companies/{company_id}/projects/{project_id}/uploads` | POST, PUT, PATCH, GET | Upload binary file to Procore storage and poll processing status using the **V2.1 Unified File Upload API** |
4747
| 6 | `.../document_uploads` | PATCH | Associate the uploaded file, set metadata, mark upload as COMPLETED |
4848
| 7 | `.../document_uploads/{document_upload_id}` | GET | Retrieve `latest_event_id` (required for submission) and optionally review Machine Learning (ML) populated fields |
49-
| 8 | `.../document_revisions` | POST | Submit uploads to create document revisions |
49+
| 8 | `/rest/v2.1/companies/{company_id}/projects/{project_id}/document_management/document_revisions` | POST | Submit uploads to create document revisions |
5050

5151
Step 5 (binary file upload) can be performed before or after Step 4 (initialize document upload records). Both steps must be completed before Step 6 (Patch document uploads).
5252
Keep batches to 100 items or fewer in Steps 4, 6, and 8 as larger payloads increase the risk of timeouts and make partial-failure recovery more complex.
@@ -636,10 +636,13 @@ GET /rest/v2.0/companies/{company_id}/projects/{project_id}/document_management/
636636

637637
Convert your document upload into a permanent project record. Once a document upload has `upload_status: COMPLETED`, all required metadata fields populated, and a `latest_event_id` retrieved, it is ready for final submission. Submitted document uploads get removed from the uploads list and are no longer retrievable. This POST request consumes your temporary upload ID and creates a versioned Document Revision. Procore will automatically place this new revision into the correct Document Container based on the metadata matching criteria.
638638

639-
**Request** — [Create Document Revisions](https://developers.procore.com/reference/rest/document-revisions?version=2.0#bulk-create-document-revisions)
639+
> This submit step uses the **V2.1** Document Revisions endpoint.
640+
{: .callout .callout--note}
641+
642+
**Request** — [Create Document Revisions](https://developers.procore.com/reference/rest/document-revisions?version=2.1#bulk-create-document-revisions)
640643

641644
```
642-
POST /rest/v2.0/companies/{company_id}/projects/{project_id}/document_management/document_revisions
645+
POST /rest/v2.1/companies/{company_id}/projects/{project_id}/document_management/document_revisions
643646
```
644647

645648
**Request Body**
@@ -673,7 +676,6 @@ POST /rest/v2.0/companies/{company_id}/projects/{project_id}/document_management
673676
<pre><code>{
674677
"data": {
675678
"ids": ["01JDXMPK0TRV0BA5K8GSSY6J0Y"],
676-
"failureIds": [],
677679
"failures": [
678680
{
679681
"upload_id": "01JDXMPK0NTP0G50E3NYY51Q5S",
@@ -687,7 +689,7 @@ POST /rest/v2.0/companies/{company_id}/projects/{project_id}/document_management
687689

688690
**`ids`** — The created document revision IDs. These are stable, permanent identifiers — use them (not upload IDs) for any subsequent references or integrations.
689691

690-
**`failures`** — Array of per-item failures that occurred during processing. Check this array even on a 201 response. Each entry contains `upload_id`, `reason_code`, and `message`. `failureIds` is also present but deprecated, use `failures` instead.
692+
**`failures`** — Array of per-item failures that occurred during processing. Check this array even on a 201 response. Each entry contains `upload_id`, `reason_code`, and `message`.
691693

692694
***
693695

@@ -990,7 +992,7 @@ Fields used from previous steps:
990992
- `upload_latest_event_id`: `latest_event_id` from Step 7 (`01JDXMPK0REV0D87H0JVVZ8M2W`)
991993

992994
```json
993-
POST /rest/v2.0/companies/8089/projects/2305/document_management/document_revisions
995+
POST /rest/v2.1/companies/8089/projects/2305/document_management/document_revisions
994996

995997
{
996998
"uploads": [

0 commit comments

Comments
 (0)