View a Cost Category by Name and Workspace
get
/primeapi/restapi/costCategory/workspace/{workspaceId}/name/{name}
This endpoint returns cost categories that meet the following requirements:
- The object has a name that matches the value of the {name} path parameter.
- The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Request
Path Parameters
-
name: string
Name of Cost Category to be found.
-
workspaceId: integer(int64)
Returns Cost Categories for specified workspace ID.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityCostCategory
Type:
Show Source
object
-
abbreviation(optional):
string
Allowed Values:
[ "Length[1-10]" ]
-
costCategoryId:
integer(int64)
-
costCategoryName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
-
link(optional):
string(url)
Read Only:
true
-
pushDownType(optional):
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
Specifies how a workspace calendar is shared across child workspaces. -
type(optional):
string
Allowed Values:
[ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ]
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId(optional):
integer(int64)
204 Response
Successful operation with no content.
404 Response
The requested cost category does not exist, or you do not have access to it.