Batch Create Cost Categories
post
/api/restapi/costCategory/batch
Send a request to this endpoint to create one or more cost categories. An application object will be created for each JSON object provided in the request body.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityCostCategoryInput>
Type:
array
Title:
Show Source
List<ApiEntityCostCategoryInput>
-
Array of:
object ApiEntityCostCategoryInput
Title:
ApiEntityCostCategoryInput
This entity represents a CostCategory object, a unique CostCategory object can be identified by the following combinations of the fields.- costCategoryId
- abbreviation,costCategoryName,workspaceId
- abbreviation,costCategoryName,workspaceCode
Nested Schema : ApiEntityCostCategoryInput
Type:
object
Title:
ApiEntityCostCategoryInput
This entity represents a CostCategory object, a unique CostCategory object can be identified by the following combinations of the fields.
Show Source
- costCategoryId
- abbreviation,costCategoryName,workspaceId
- abbreviation,costCategoryName,workspaceCode
-
abbreviation(required): string
Minimum Length:
1
Maximum Length:10
The abbreviation for the cost category name. -
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 24.5.The type of association in the relationship between the cost category and the workspace. Possible values are Owned and Inherited. -
costCategoryId: integer
(int64)
The system-generated identifier of a cost category.
-
costCategoryName(required): string
Minimum Length:
1
Maximum Length:255
The name of the cost category. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
How data is shared between parent and child workspaces.
Manual: Data can be pulled down by child workspaces. This is the default option.
Automatic: Data is automatically shared with all child workspaces. -
type(required): string
Allowed Values:
[ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ]
The classification of the cost category.
Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
Other: Cost is manually entered as a lump sum. -
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. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : List<ApiEntityCostCategory>
Type:
array
Title:
Show Source
List<ApiEntityCostCategory>
-
Array of:
object ApiEntityCostCategory
Title:
ApiEntityCostCategory
Nested Schema : ApiEntityCostCategory
Type:
object
Title:
Show Source
ApiEntityCostCategory
-
abbreviation: string
Minimum Length:
1
Maximum Length:10
The abbreviation for the cost category name. -
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the cost category and the workspace. Possible values are Owned and Inherited. -
costCategoryId: integer
(int64)
The system-generated identifier of a cost category.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the cost category. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
How data is shared between parent and child workspaces.
Manual: Data can be pulled down by child workspaces. This is the default option.
Automatic: Data is automatically shared with all child workspaces. -
type: string
Allowed Values:
[ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ]
The classification of the cost category.
Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
Other: Cost is manually entered as a lump sum. -
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. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
400 Response
Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request.