Jump to

• Request
• Response

View a Program Budget Item by Code and Parent Codes

get

/api/restapi/programBudgetItem/byItemCode

Send a request to this endpoint to view a program budget item with codes matching the code fields in query parameters.

Request

Query Parameters

• programBudgetItemCode(required): string
  The item code of a program budget item.
  This is a required field.
• programCode(required): string
  The user-specified unique identifier of a program.
  This is a required field.
• workspaceCode(required): string
  Workspace code of the budget item to be found.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityProgramBudgetItem

Type: object

Title: ApiEntityProgramBudgetItem

Show Source

• abbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviated name of a cost category.
• budgetHours: number (double)
  The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.
• cbsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code value of the CBS code. The code may have one or more segments according the ot the segment definition.
• cbsTemplateCodeId: integer (int64)
  The unique identifier of the CBS Code.
• configuredFields: array configuredFields
  An object containing configured fields in the form of key-value pairs.
• costCategoryId: integer (int64)
  The type of cost associated with the budget item.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The cost category assigned to this budget item.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget item.
• programBudgetChangeId: integer (int64)
  Indicates whether the budget item originated in a budget change.
• programBudgetId: integer (int64)
  The ID of the program budget.
• programBudgetItemCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the program budget item.
• programBudgetItemCost: programBudgetItemCost
  Contains Program Budget Item cost related fields.
• programBudgetItemId: integer (int64)
  The system-generated identifier for a budget.
• programBudgetItemName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the budget item.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• quantity: number (double)
  The number of each budget item needed to complete the work.
• sourceId: string
  Maximum Length: 255

  The unique identifier of program budget item data in an external source.
• unitsOfMeasureId: integer (int64)
  The Unit of Measure used for the budget item.
• 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 of a workspace.

{
    "title":"ApiEntityProgramBudgetItem",
    "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"
            ]
        },
        "programBudgetItemCost":{
            "description":"Contains Program Budget Item cost related fields.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramBudgetItemCost"
                }
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramBudgetItemConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget item needed to complete the work.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "productionRate":{
            "minimum":"0.000010",
            "type":"number",
            "description":"The number of hours per unit of measure needed to complete the budget item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetHours":{
            "type":"number",
            "description":"The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "programBudgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for a budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsTemplateCodeId":{
            "type":"integer",
            "description":"The unique identifier of the CBS Code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The code value of the CBS code. The code may have one or more segments according the ot the segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of program budget item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The cost category assigned to this budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviated name of a cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetId":{
            "type":"integer",
            "description":"The ID of the program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"Indicates whether the budget item originated in a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier of the program budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

An object containing configured fields in the form of key-value pairs.

Show Source

• Array of: object ApiEntityProgramBudgetItemConfiguredFieldValue
  Title: ApiEntityProgramBudgetItemConfiguredFieldValue

{
    "type":"array",
    "description":"An object containing configured fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetItemConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programBudgetItemCost

Contains Program Budget Item cost related fields.

Match All

Show Source

• object ApiEntityProgramBudgetItemCost
  Title: ApiEntityProgramBudgetItemCost

{
    "description":"Contains Program Budget Item cost related fields.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProgramBudgetItemCost"
        }
    ]
}

Nested Schema : ApiEntityProgramBudgetItemConfiguredFieldValue

Type: object

Title: ApiEntityProgramBudgetItemConfiguredFieldValue

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• programBudgetItemConfiguredFieldValueId: integer (int64)
  The unique identifier for the Budget Item Configured Field.
• programBudgetItemId: integer (int64)
  The system-generated identifier for a budget.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProgramBudgetItemConfiguredFieldValue",
    "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"
            ]
        },
        "programBudgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for a budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Budget Item Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramBudgetItemCost

Type: object

Title: ApiEntityProgramBudgetItemCost

Show Source

• currentCost: number (double)
  The current cost of the budget line item.
• currentCostWorkspace1: number (double)
  The total cost of the program budget, including all transfers and changes, based on the workspace1 currency.
• currentCostWorkspace2: number (double)
  The total cost of the program budget, including all transfers and changes, based on the workspace2 currency.
• currentCostWorkspace3: number (double)
  The total cost of the program budget, including all transfers and changes, based on the workspace3 currency.
• laborRate: number (double)
  The cost per labor hour of the budget line item.
• laborRateWorkspace1: number (double)
  The cost per labor hour of the budget line item based on the workspace1 currency.
• laborRateWorkspace2: number (double)
  The cost per labor hour of the budget line item based on the workspace2 currency.
• laborRateWorkspace3: number (double)
  The cost per labor hour of the budget line item based on the workspace3 currency.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• originalCost: number (double)
  Minimum Value: 0

  The original cost of the budget line item.
• originalCostWorkspace1: number (double)
  The total original cost of the program budget, before transfers and changes, based on the workspace1 currency.
• originalCostWorkspace2: number (double)
  The total original cost of the program budget, before transfers and changes, based on the workspace2 currency.
• originalCostWorkspace3: number (double)
  The total original cost of the project budget, before transfers and changes, based on the workspace3 currency.
• programBudgetItemId: integer (int64)
  The system-generated identifier for a budget.
• unitRate: number (double)
  The cost per Unit of Measure for the budget line item.
• unitRateWorkspace1: number (double)
  The cost per Unit of Measure for the budget line item based on the workspace1 currency.
• unitRateWorkspace2: number (double)
  The cost per Unit of Measure for the budget line item based on the workspace2 currency.
• unitRateWorkspace3: number (double)
  The cost per Unit of Measure for the budget line item based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProgramBudgetItemCost",
    "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"
            ]
        },
        "currentCost":{
            "type":"number",
            "description":"The current cost of the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRate":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRateWorkspace1":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRateWorkspace2":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitRateWorkspace3":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRate":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateWorkspace1":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateWorkspace2":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateWorkspace3":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace1":{
            "type":"number",
            "description":"The total cost of the program budget, including all transfers and changes, based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace2":{
            "type":"number",
            "description":"The total cost of the program budget, including all transfers and changes, based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentCostWorkspace3":{
            "type":"number",
            "description":"The total cost of the program budget, including all transfers and changes, based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "programBudgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for a budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "originalCost":{
            "minimum":"0",
            "type":"number",
            "description":"The original cost of the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostWorkspace1":{
            "type":"number",
            "description":"The total original cost of the program budget, before transfers and changes, based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostWorkspace2":{
            "type":"number",
            "description":"The total original cost of the program budget, before transfers and changes, based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostWorkspace3":{
            "type":"number",
            "description":"The total original cost of the project budget, before transfers and changes, based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

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

Back to Top