Jump to

• Request
• Response

View a Cost Category by Name and Workspace

get

/api/restapi/costCategory/workspace/{workspaceId}/name/{costCategoryName}

This endpoint returns cost categories that meet the following requirements:

• The object has a name that matches the value of the {costCategoryName} 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

• costCategoryName(required): string
  Name of Cost Category to be found.
• workspaceId(required): integer(int64)
  The system-generated unique identifier of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityCostCategory>

Type: array

Title: List<ApiEntityCostCategory>

Show Source

• Array of: object ApiEntityCostCategory
  Title: ApiEntityCostCategory

{
    "title":"List<ApiEntityCostCategory>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCostCategory",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCostCategory

Type: object

Title: ApiEntityCostCategory

Show Source

• 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.

{
    "title":"ApiEntityCostCategory",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"The classification of the cost category. <br />Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate. <br />Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate. <br />Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate. <br />Other: Cost is manually entered as a lump sum.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "LABOR",
                "EQUIPMENT",
                "MATERIALS",
                "OTHER"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the cost category and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "abbreviation":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviation for the cost category name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested cost category does not exist, or you do not have access to it.

Back to Top