POST /rest/v1.0/coordination_issues
Create a Coordination Issue in a Project
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. |
coordination_issue |
Object | Yes |
Coordination Issue |
coordination_issue.description |
String | No |
Coordination Issue description. |
coordination_issue.uuid |
String | No |
Coordination Issue UUID. This is an optional parameter, and is set automatically on server if not present in the payload |
coordination_issue.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. |
coordination_issue.viewpoints[].visibility |
Object | No |
Object visibility settings |
coordination_issue.viewpoints[].visibility.exceptions |
Object | No |
Group of model objects represented as an array of object ids, or object ranges |
coordination_issue.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. |
coordination_issue.viewpoints[].visibility.exceptions.object_ids[] |
Array | No |
Array of object ids |
coordination_issue.viewpoints[].visibility.default_visibility |
Boolean | No | |
coordination_issue.viewpoints[].sections_data |
String | No |
JSON string representation of sections applied to a 3d model as a bounding box |
coordination_issue.viewpoints[].name |
String | No |
Viewpoint name |
coordination_issue.viewpoints[].view_folder_id |
Integer | No |
ID of the BIM View Folder the viewpoint belongs to |
coordination_issue.viewpoints[].snapshot_upload_uuid |
String | Yes |
UUID of uploaded snapshot |
coordination_issue.viewpoints[].render_mode |
String | No |
Viewer render mode when viewpoint is applied Possible values:
|
coordination_issue.viewpoints[].camera_data |
String | Yes |
JSON string representation of camera position |
coordination_issue.viewpoints[].redlines_data |
String | No |
JSON string representation of markup |
coordination_issue.status |
String | No |
Status of the issue. Should be either open or closed Possible values:
|
coordination_issue.bim_model_id |
Integer | No |
ID of the model to be associated |
coordination_issue.trade_id |
Integer | No |
Trade associated with the Coordination Issue |
coordination_issue.location_id |
Integer | No |
Location where the issue is present. The location must be in the same project as the project_id |
coordination_issue.priority |
String | No |
Priority of the Coordination Issue Possible values:
|
coordination_issue.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 |
coordination_issue.assignee_id |
Integer | No |
ID of Procore user that should be assigned the issue |
coordination_issue.attachment_upload_uuids[] |
Array | No | |
coordination_issue.attachments[] |
Array | No | |
coordination_issue.coordination_issue_file_id |
Integer | No |
ID of the BIM File to be set as origin source (required if viewpoints is included in payload) |
coordination_issue.title |
String | Yes |
Coordination Issue title. The title can have a maximum of 80 characters |
coordination_issue.origin |
Object | No |
Origin source for a Coordination Issue |
coordination_issue.origin.origin_type |
String | Yes |
Type of origin item |
coordination_issue.origin.origin_id |
String | Yes |
Id of the origin item |
coordination_issue.origin.title |
String | Yes |
Title of the origin item |
coordination_issue.origin.deep_link_url |
String | Yes |
Deep link URL to the origin item |
coordination_issue.creation_source |
String | No |
Source of issue creation. This attribute is ignored when issue is create by third party developers. |
coordination_issue.issue_type |
String | No |
Issue Type of the Coordination Issue Possible values:
|
coordination_issue.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.