Batch Update Project Companies
put
/api/restapi/projectCompany/batch
Send a request to this endpoint to update one or more project companies.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityProjectCompanyInput>
Type:
array
Title:
Show Source
List<ApiEntityProjectCompanyInput>
-
Array of:
object ApiEntityProjectCompanyInput
Title:
ApiEntityProjectCompanyInput
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 : ApiEntityProjectCompanyInput
Type:
object
Title:
ApiEntityProjectCompanyInput
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(required): string
Minimum Length:
1
Maximum Length:6
The selected color representation of the company. -
companyId(required): 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)Read Only:true
Deprecated. As of 24.5.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(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 24.5.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid input for a baseline company.