View all Project Companies by Project
get
/api/restapi/projectCompany/project/{projectId}
This endpoint returns project companies that meet the following requirements:
- The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
Request
Path Parameters
-
projectId(required): integer(int64)
ID of the project to be found.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProjectCompany>
Type:
array
Title:
Show Source
List<ApiEntityProjectCompany>
-
Array of:
object ApiEntityProjectCompany
Title:
ApiEntityProjectCompany
This entity represents a ProjectCompany object, a unique ProjectCompany object can be identified by the following combinations of the fields.- projectCompanyId
- projectId,companyId
- companyId,projectCode,workspaceCode
- companyName,postalCode,projectId
- companyName,postalCode,projectCode,workspaceCode
Nested Schema : ApiEntityProjectCompany
Type:
object
Title:
ApiEntityProjectCompany
This entity represents a ProjectCompany object, a unique ProjectCompany object can be identified by the following combinations of the fields.
Show Source
- projectCompanyId
- projectId,companyId
- companyId,projectCode,workspaceCode
- companyName,postalCode,projectId
- companyName,postalCode,projectCode,workspaceCode
-
color: string
Minimum Length:
1
Maximum Length:6
The selected color representation of the company. -
companyId: integer
(int64)
The unique identifier for the company.The company object can also be identified by its unique criteria.
-
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
postalCode: string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectCompanyId: integer
(int64)
The system-generated unique identifier of the project company.
-
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
204 Response
Successful operation with no content.
404 Response
The requested project company does not exist, or you do not have access to it.