PATCH /rest/v1.0/coordination_issues/sync
This endpoint is used to create and update a batch of CoordinationIssues. See Using Sync Actions for additional information.
If an 'id' attribute is present in any payload item, that item is processed for 'update'. Only title, description, due_date, location_id, assignee_id, issue_type, priority, and trade_id can be updated using this endpoint.
Servers
- https://api.procore.com
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. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
updates[] |
Array | Yes |
An array of coordination issue payloads |
updates[].description |
String | No |
Coordination Issue description. |
updates[].uuid |
String | No |
Coordination Issue UUID. This is an optional parameter, and is set automatically on server if not present in the payload |
updates[].viewpoints[] |
Array | No |
An array of issue viewpoints. Only one viewpoint is allowed at this time. If specified, must also include coordination_issue_file_id. |
updates[].viewpoints[].visibility |
Object | No |
Object visibility settings |
updates[].viewpoints[].visibility.exceptions |
Object | No |
Group of model objects represented as an array of object ids, or object ranges |
updates[].viewpoints[].visibility.exceptions.object_ranges[] |
Array | No |
Array of object ranges. A range is an array containing two numbers, the first represents object id, the second represents the number of objects in the range. |
updates[].viewpoints[].visibility.exceptions.object_ids[] |
Array | No |
Array of object ids |
updates[].viewpoints[].visibility.default_visibility |
Boolean | No | |
updates[].viewpoints[].sections_data |
String | No |
JSON string representation of sections applied to a 3d model as a bounding box |
updates[].viewpoints[].name |
String | No |
Viewpoint name |
updates[].viewpoints[].view_folder_id |
Integer | No |
ID of the BIM View Folder the viewpoint belongs to |
updates[].viewpoints[].snapshot_upload_uuid |
String | Yes |
UUID of uploaded snapshot |
updates[].viewpoints[].render_mode |
String | No |
Viewer render mode when viewpoint is applied Possible values:
|
updates[].viewpoints[].camera_data |
String | Yes |
JSON string representation of camera position |
updates[].viewpoints[].redlines_data |
String | No |
JSON string representation of markup |
updates[].status |
String | No |
Status of the issue. Should be either open or closed Possible values:
|
updates[].bim_model_id |
Integer | No |
ID of the model to be associated |
updates[].trade_id |
Integer | No |
Trade associated with the Coordination Issue |
updates[].location_id |
Integer | No |
Location where the issue is present. The location must be in the same project as the project_id |
updates[].priority |
String | No |
Priority of the Coordination Issue Possible values:
|
updates[].drawing_revision_id |
Integer | No |
ID of the drawing revision to be set as origin source. Only one of drawing_revision_id or coordination_issue_file_id can be present |
updates[].assignee_id |
Integer | No |
ID of Procore user that should be assigned the issue |
updates[].attachment_upload_uuids[] |
Array | No | |
updates[].attachments[] |
Array | No | |
updates[].coordination_issue_file_id |
Integer | No |
ID of the BIM File to be set as origin source (required if viewpoints is included in payload) |
updates[].title |
String | Yes |
Coordination Issue title. The title can have a maximum of 80 characters |
updates[].origin |
Object | No |
Origin source for a Coordination Issue |
updates[].origin.origin_type |
String | Yes |
Type of origin item |
updates[].origin.origin_id |
String | Yes |
Id of the origin item |
updates[].origin.title |
String | Yes |
Title of the origin item |
updates[].origin.deep_link_url |
String | Yes |
Deep link URL to the origin item |
updates[].creation_source |
String | No |
Source of issue creation. This attribute is ignored when issue is create by third party developers. |
updates[].issue_type |
String | No |
Issue Type of the Coordination Issue Possible values:
|
updates[].due_date |
String | No |
Due date of the Coordination Issue |
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.