Jump to

• Request
• Response

Update a Cost Category

put

/api/restapi/costCategory

Send a request to this endpoint to update a cost category. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

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

• costCategoryId
• abbreviation,costCategoryName,workspaceId
• abbreviation,costCategoryName,workspaceCode

Show Source

• abbreviation(required): string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviation for the cost category name.
• associationType: string
  Read 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.

{
    "title":"ApiEntityCostCategoryInput",
    "required":[
        "abbreviation",
        "costCategoryName",
        "type",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The type of association in the relationship between the cost category and the workspace. Possible values are Owned and Inherited.",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        }
    },
    "description":"This entity represents a CostCategory object, a unique CostCategory object can be identified by the following combinations of the fields.<ul><li>costCategoryId</li><li>abbreviation,costCategoryName,workspaceId</li><li>abbreviation,costCategoryName,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Cost Category using Cost Category ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request.

Back to Top