Skip to content

feat: add document management metadata documentation#328

Merged
yoasyo25 merged 4 commits intomainfrom
ya/DOCINT-1056/pdm_api_metadata_documentation
Feb 6, 2026
Merged

feat: add document management metadata documentation#328
yoasyo25 merged 4 commits intomainfrom
ya/DOCINT-1056/pdm_api_metadata_documentation

Conversation

@yoasyo25
Copy link
Contributor

@yoasyo25 yoasyo25 commented Feb 2, 2026 •
edited
Loading

Jira Ticket:
🎫 DOCINT-1056

Summary
Adds documentation for PDM metadata.

Change Type(s)

  • Bugfix (if so, add before/after behavior description below)
  • Docs
  • New Feature
  • Refactor
  • Specs

Copilot AI review requested due to automatic review settings February 2, 2026 16:58
@yoasyo25 yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_metadata_documentation branch from 6b03448 to beb7c5f Compare February 2, 2026 16:59
@yoasyo25 yoasyo25 self-assigned this Feb 2, 2026
@yoasyo25 yoasyo25 requested a review from a team February 2, 2026 16:59
Copilot AI reviewed Feb 2, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for the Document Management Integration, specifically covering metadata structure and API endpoints for document upload and revision operations.

Changes:

  • Added detailed metadata field reference documentation covering standard, system, placeholder, workflow, and custom fields
  • Added API endpoints reference page with links to all Document Management endpoints
  • Included examples of field types, value structures, and complete API response

Reviewed changes

Copilot reviewed 1 out of 1 changed files in this pull request and generated 8 comments.

File Description
document_management_integration/document_management_metadata_details.md Comprehensive documentation of document metadata structure, field types, value sources, and integration processing with example responses
document_management_integration/document_management_api_endpoints.md Quick reference table of Document Management API endpoints with descriptions and URIs

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

@yoasyo25 yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_metadata_documentation branch from beb7c5f to 8ee7c64 Compare February 2, 2026 18:49
@yoasyo25 yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_metadata_documentation branch from 8ee7c64 to 02321f5 Compare February 2, 2026 18:51
kangster
kangster reviewed Feb 3, 2026
View reviewed changes
document_management_integration/document_management_metadata_details.md
| **timestamp** | Date and time in ISO 8601 UTC format |
| **lov_entry** | Single selection from project-configured list of values |
| **lov_entries** | Multiple selections from project-configured list of values |
| **reference** | Link to another entity such as users, locations, or workflows |
Copy link
Contributor

@kangster kangster Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is also a numeric field type

document_management_integration/document_management_metadata_details.md Outdated

## Field Type Reference

In the Document Upload and Document Revision API responses, each field object in the `fields` array includes a `type` property that determines its value format and structure.
Copy link
Contributor

@kangster kangster Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider possibly linking the API documentation

document_management_integration/document_management_metadata_details.md
***
<details>
<summary class="collapseListTierOne">Overview of document metadata fields</summary>
<pre><code>{
Copy link
Contributor

@kangster kangster Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I preview this code block, the formatting is off for some reason.

Copy link
Contributor Author

@yoasyo25 yoasyo25 Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried to address the formatting issue. Let me know if it's still showing up.

Copy link
Contributor

@kangster kangster Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preview

Not sure if it's because of the comments like // For text-based types (string, rich_text, timestamp, numeric): but the indenting is lost after "fields".

Copy link
Contributor Author

@yoasyo25 yoasyo25 Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the formatting a bit more.

It doesn't have the weird formatting issue locally when I run the server and navigate to the metadata page.

Screenshot 2026-02-06 at 9 44 47 AM

yoasyo25 and others added 2 commits February 5, 2026 09:58
@yoasyo25 yoasyo25 force-pushed the ya/DOCINT-1056/pdm_api_metadata_documentation branch from 9dd8116 to 3cb4cfc Compare February 5, 2026 15:54
@yoasyo25 yoasyo25 requested a review from kangster February 5, 2026 15:55
cagmz
cagmz reviewed Feb 5, 2026
View reviewed changes
document_management_integration/document_management_metadata_details.md Outdated
- **Integrate with naming standards**: Some custom fields can be extracted from filenames
- **Support workflows**: Can be used in workflow rules and permission groups

To retrieve available custom fields for a project, use the [List Project Fields](https://developers.procore.com/reference/rest/project-fields?version=latest) endpoint.
Copy link

@cagmz cagmz Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this PDM API return Custom Fields for the PDM Project? If so, do we know if a field is a Custom Field due to the custom_field_definition_id?

Or should we be linking to a Custom Fields API endpoint instead (not sure which of these)?

Copy link
Contributor Author

@yoasyo25 yoasyo25 Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it returns custom_field_definition_id for custom fields. I updated the text to indicate this.

@yoasyo25 yoasyo25 requested a review from cagmz February 6, 2026 15:45
@yoasyo25 yoasyo25 merged commit c755a36 into main Feb 6, 2026
3 checks passed
@yoasyo25 yoasyo25 deleted the ya/DOCINT-1056/pdm_api_metadata_documentation branch February 6, 2026 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@kangster kangster kangster approved these changes

@cagmz cagmz cagmz approved these changes

Assignees

@yoasyo25 yoasyo25

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@yoasyo25 @kangster @cagmz