View a Cost Category by Name
get
/api/restapi/costCategory/name/{costCategoryName}
This endpoint returns a cost category. that meet the following requirements:
- The object has a name that matches the value of the {costCategoryName} path parameter.
Request
Path Parameters
-
costCategoryName(required): string
Name of Cost Category 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<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.
204 Response
Successful operation with no content.
404 Response
The requested cost category does not exist, or you do not have access to it.