POST /rest/v2.0/companies/{company_id}/projects/{project_id}/viewer_documents
Find or create an Annotated Document where markup may be added. Supports filtering by markup context and pin origin.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
String | Yes |
Unique identifier of the project |
company_id |
String | Yes |
Unique identifier of the company |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
combined_xfdf |
Boolean | No |
When true, return combined XFDF instead of per-markup XFDF Default value: true |
pin_origin |
String | No |
Origin of the pin (WORKFLOW or WORKSPACE), required when markup_context is PIN |
markup_context |
String | No |
Filter by markup context (WORKFLOW, WORKSPACE, or PIN) |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
attachment_source |
String | No | |
attachment_id |
String | No | |
item_type |
String | Yes | |
item_id |
String | Yes |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.