feat: add document management intro documentation #326

yoasyo25 · 2026-01-26T22:12:54Z

Change Type(s)

Summary 📚

This pull request adds overview documentation for Procore's Document Management integration. The core introductory guide now details prerequisites, core concepts, workflows, best practices, and machine learning features. Additionally, new reference pages for API endpoints and metadata details are introduced.

Key documentation additions and improvements:

1. Document Management Introduction

Provides an overview of the Document Management system, including prerequisites, core concepts (such as Document Uploads, Revisions, and Containers), organization principles, and the overall workflow for integrating with the API.

2. Addition of Document Management API Endpoints Reference

Introduces a new markdown file (document_management_api_endpoints.md) with a table summarizing all key API endpoints for document uploads, revisions, metadata, and related resources, including links to Procore's developer documentation.

3. Scaffold for Metadata Details Documentation

Adds a new file (document_management_metadata_details.md) as a placeholder for future content detailing document metadata fields and requirements.

Copilot

Pull request overview

This PR adds introductory documentation for Procore's Document Management integration along with supporting reference pages. It introduces a detailed integration overview guide, an API endpoints reference, and a placeholder page for metadata details.

Changes:

Expand document_management_intro.md into a full conceptual + best-practices guide for Document Management integrations, including workflows and ML behavior.
Add document_management_api_endpoints.md with a tabular summary of the primary Document Management REST endpoints.
Add document_management_metadata_details.md as a new (currently placeholder) page intended to document metadata details.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
`document_management_integration/document_management_intro.md`	Introduces a comprehensive overview of PDM concepts, workflows, ML behavior, and integration best practices, with cross-links to related guides.
`document_management_integration/document_management_api_endpoints.md`	Adds a table of core Document Management API endpoints, actions, and descriptions for quick reference.
`document_management_integration/document_management_metadata_details.md`	Adds a new metadata details page with frontmatter wired up but no substantive content yet.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

document_management_integration/document_management_intro.md

document_management_integration/document_management_api_endpoints.md

document_management_integration/document_management_metadata_details.md

document_management_integration/document_management_intro.md

kangster · 2026-01-27T16:57:53Z

document_management_integration/document_management_intro.md

+
+## Next Steps
+
+See the [Document Management Technical Guide]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_technical_guide.md %}) for detailed step-by-step instructions on using the document management APIs.


Do you plan to add this page in a follow up?

Yes, I was going to cover that in https://procoretech.atlassian.net/browse/DOCINT-1073

kangster · 2026-01-27T17:08:28Z

document_management_integration/document_management_api_endpoints.md

+
+| Name | Action | Endpoint URI | Description |
+| --- | --- | --- | --- |
+| [Create Document Uploads](https://developers.procore.com/reference/rest/document-uploads?version=latest#bulk-create-document-uploads) | POST | /rest/v2.0/companies/{company_id}/projects/{project_id}/document_management/document_uploads | Creates one or more new Document Uploads in the specified Project. |


Do you plan to add more details about how to use the api endpoints? It might help to group the applicable endpoints for "create document upload" to show where to get values as part of the upload payload. Were you planing to cover this in the technical guide?

Yes, I was going to add details for how to use the endpoints in the technical guide.
But I do like your suggestion of grouping the endpoints. Will do that in a follow up ticket.

document_management_integration/document_management_intro.md

kangster · 2026-01-27T17:22:07Z

document_management_integration/document_management_intro.md

+PDM follows a two-stage workflow for ingesting documents:
+
+**Stage 1: Document Upload** - Integrator uploads a file to Procore and sends a post request to document service upload endpoint. The system assigns a unique Upload ID, calculates container placement based on metadata, and triggers ML analysis. The upload can be edited and updated until submission. This stage allows for:
+- Metadata review and enrichment before finalization


I think clarifying here that all required information must be provided before the upload can be submitted. Checking against the upload requirements.

Co-authored-by: David Kang <[email protected]>

cagmz · 2026-01-27T20:50:41Z

document_management_integration/document_management_intro.md

+
+PDM follows a two-stage workflow for ingesting documents:
+
+**Stage 1: Document Upload** - Integrator uploads a file to Procore and sends a post request to document service upload endpoint. The system assigns a unique Upload ID, calculates container placement based on metadata, and triggers ML analysis. The upload can be edited and updated until submission. This stage allows for:


Suggested change

**Stage 1: Document Upload** - Integrator uploads a file to Procore and sends a post request to document service upload endpoint. The system assigns a unique Upload ID, calculates container placement based on metadata, and triggers ML analysis. The upload can be edited and updated until submission. This stage allows for:

**Stage 1: Document Upload** - Integrator uploads a file to Procore and sends a post request to the Document Management upload endpoint.

I suggest replacing "document service" with Document Management for consistency.

Also, should we be describing how to upload a file to Procore in more detail? Is this actually a 3-step process?

cagmz · 2026-01-27T20:59:54Z

document_management_integration/document_management_intro.md

+To get started with the Document Management API, ensure you have completed these steps:
+
+- **Account Setup** - Create a Procore service account. See [Creating an App]({{ site.url }}{{ site.baseurl }}{% link building_applications/building_apps_create_new.md %}) for additional information.
+- **Tool Setup** - Enable the Document Management tool at the Project level for the integrator app.


Suggested change

- **Tool Setup** - Enable the Document Management tool at the Project level for the integrator app.

- **Tool Setup** - Enable the Document Management tool at the Project level for the Procore service account.

I suggest linking to this page and replacing "service account" with "Developer Managed Service Account" for consistency : https://developers.procore.com/documentation/developer-managed-service-accounts

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

cagmz

Great work! Especially "How Document Management Works".

Copilot AI review requested due to automatic review settings January 26, 2026 22:12

Copilot started reviewing on behalf of yoasyo25 January 26, 2026 22:13 View session

yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_overview_documentation branch from 78979c7 to 58aabea Compare January 26, 2026 22:13

yoasyo25 self-assigned this Jan 26, 2026

Copilot AI reviewed Jan 26, 2026

View reviewed changes

feat: add document management intro documentation

1fe76b1

yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_overview_documentation branch from 58aabea to 1fe76b1 Compare January 26, 2026 22:42

yoasyo25 requested a review from a team January 27, 2026 14:11

kangster reviewed Jan 27, 2026

View reviewed changes

fix: update reference links

b3d66b0

Co-authored-by: David Kang <[email protected]>

cagmz reviewed Jan 27, 2026

View reviewed changes

yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_overview_documentation branch 2 times, most recently from c2007d5 to a2ef811 Compare January 28, 2026 20:07

refactor: clarify api workflow

a6b487b

yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_overview_documentation branch from a2ef811 to a6b487b Compare January 28, 2026 20:08

yoasyo25 requested review from cagmz, Copilot and kangster January 28, 2026 20:08

Copilot started reviewing on behalf of yoasyo25 January 28, 2026 20:09 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

cagmz approved these changes Jan 29, 2026

View reviewed changes


		## Next Steps

		See the [Document Management Technical Guide]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_technical_guide.md %}) for detailed step-by-step instructions on using the document management APIs.


		PDM follows a two-stage workflow for ingesting documents:

		Stage 1: Document Upload - Integrator uploads a file to Procore and sends a post request to document service upload endpoint. The system assigns a unique Upload ID, calculates container placement based on metadata, and triggers ML analysis. The upload can be edited and updated until submission. This stage allows for:

	- Tool Setup - Enable the Document Management tool at the Project level for the integrator app.
	- Tool Setup - Enable the Document Management tool at the Project level for the Procore service account.

feat: add document management intro documentation #326

Are you sure you want to change the base?

feat: add document management intro documentation #326

Conversation

yoasyo25 commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary 📚

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kangster Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

yoasyo25 Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

kangster Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

yoasyo25 Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kangster Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

cagmz Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

cagmz Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

cagmz left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

yoasyo25 commented Jan 26, 2026 •

edited

Loading