Jump to

• Request
• Response

View a Project Actuals Line Item by Code

get

/api/restapi/projectActualsLineItem/code/{projectActualsLineItemCode}

This endpoint returns project actual line items that meet the following requirements:

• The object has a code that matches the value of the {projectActualsLineItemCode} path parameter.

Request

Path Parameters

• projectActualsLineItemCode(required): string
  The user-specified identifier of a project actual line item.

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<ApiEntityProjectActualsLineItem>

Type: array

Title: List<ApiEntityProjectActualsLineItem>

Show Source

• Array of: object ApiEntityProjectActualsLineItem
  Title: ApiEntityProjectActualsLineItem

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

Nested Schema : ApiEntityProjectActualsLineItem

Type: object

Title: ApiEntityProjectActualsLineItem

Show Source

• cbsCodes: array cbsCodes
  List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
• cbsCodeSourceId: string
  Maximum Length: 255

  The unique identifier of CBS data in an external source.
• cbsSheetCodeId: integer (int64)
  The CBS code assigned to the actual line item.
• costCategoryAbbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviated name of a cost category.
• costCategoryId: integer (int64)
  The system-generated identifier of cost category associated with the project actual line item.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the cost category associated with the project actual line item.
• hours: number (double)
  The number of hours needed to complete the actual line item.
• itemSuffix: integer (int64)
  Auto numbering suffix of a project actuals line item code.
• lineItemType: string
  Allowed Values: [ "LUMP_SUM", "UNIT_PRICE" ]

  The type assigned to an actual line item.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• name: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the actual line item.
• projectActualsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project actual.
• projectActualsId: integer (int64)
  The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
• projectActualsLineItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for an actual line item.
• projectActualsLineItemCost: projectActualsLineItemCost
  The cost fields associated with a line item.
• projectActualsLineItemId: integer (int64)
  The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
• projectActualsSourceId: string
  Maximum Length: 255

  The unique identifier of project actual data in an external source.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• quantity: integer (int64)
  The quantity of the actual line item.
  If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
  If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.
• sourceId: string
  Maximum Length: 255

  The unique identifier of project actual line item data in an external source.
• unitOfMeasureId: integer (int64)
  The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.
• unitOfMeasureValue: string
  Minimum Length: 0

  Maximum Length: 255

  The value of a units of measure.
• 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.

{
    "title":"ApiEntityProjectActualsLineItem",
    "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"
            ]
        },
        "name":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "hours":{
            "type":"number",
            "description":"The number of hours needed to complete the actual line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "cbsCodes":{
            "type":"array",
            "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lineItemType":{
            "type":"string",
            "description":"The type assigned to an actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "LUMP_SUM",
                "UNIT_PRICE"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantity":{
            "type":"integer",
            "description":"The quantity of the actual line item. <br />If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered. <br />If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The CBS code assigned to the actual line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project actual line item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of cost category associated with the project actual line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the cost category associated with the project actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemSuffix":{
            "type":"integer",
            "description":"Auto numbering suffix of a project actuals line item code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryAbbreviation":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviated name of a cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsLineItemCost":{
            "description":"The cost fields associated with a line item.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCost"
                }
            ]
        },
        "cbsCodeSourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of CBS data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitOfMeasureValue":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The value of a units of measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsSourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project actual data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsLineItemId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsLineItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for an actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : cbsCodes

Type: array

List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectActualsLineItemCost

The cost fields associated with a line item.

Match All

Show Source

• object ApiEntityProjectActualsLineItemCost
  Title: ApiEntityProjectActualsLineItemCost

{
    "description":"The cost fields associated with a line item.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCost"
        }
    ]
}

Nested Schema : ApiEntityProjectActualsLineItemCost

Type: object

Title: ApiEntityProjectActualsLineItemCost

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectActualsLineItem: projectActualsLineItem
  Deprecated. As of 23.6.
  The system-generated identifier of a line item.
• projectActualsLineItemId: integer (int64)
  The system-generated identifier of a project actual line item.
• total: number (double)
  The cost amount associated with the actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
• totalProject: number (double)
  The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the project currency.
• totalProjectActuals: number (double)
  The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.
• totalWorkspace1: number (double)
  The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace3 currency.
• unitPrice: number (double)
  The price associated with the actual line item.
  If a Unit of Measure is associated with the actual line item, the Unit Price is the unit price per measure. This field is in base currency and is calculated from unitPriceProject field based on the specified exchange rate.
• unitPriceProject: number (double)
  The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the project currency.
• unitPriceProjectActuals: number (double)
  The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the record level currency.
• unitPriceWorkspace1: number (double)
  The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace1 currency.
• unitPriceWorkspace2: number (double)
  The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace2 currency.
• unitPriceWorkspace3: number (double)
  The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectActualsLineItemCost",
    "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"
            ]
        },
        "total":{
            "type":"number",
            "description":"The cost amount associated with the actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalProjectActuals":{
            "type":"number",
            "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitPrice":{
            "type":"number",
            "description":"The price associated with the actual line item. <br />If a Unit of Measure is associated with the actual line item, the Unit Price is the unit price per measure. This field is in base currency and is calculated from unitPriceProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitPriceProject":{
            "type":"number",
            "description":"The price associated with the actual line item. If a <b>unit of measure</b> is associated with the actual line item, the <b>unit price</b> is the unit price per measure. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitPriceWorkspace1":{
            "type":"number",
            "description":"The price associated with the actual line item. If a <b>unit of measure</b> is associated with the actual line item, the <b>unit price</b> is the unit price per measure. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitPriceWorkspace2":{
            "type":"number",
            "description":"The price associated with the actual line item. If a <b>unit of measure</b> is associated with the actual line item, the <b>unit price</b> is the unit price per measure. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitPriceWorkspace3":{
            "type":"number",
            "description":"The price associated with the actual line item. If a <b>unit of measure</b> is associated with the actual line item, the <b>unit price</b> is the unit price per measure. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitPriceProjectActuals":{
            "type":"number",
            "description":"The price associated with the actual line item. If a <b>unit of measure</b> is associated with the actual line item, the <b>unit price</b> is the unit price per measure. This value is based on the record level currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectActualsLineItem":{
            "description":"<b>Deprecated.</b> As of <i>23.6</i>.</br>The system-generated identifier of a line item.",
            "deprecated":true,
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem"
                }
            ]
        },
        "totalProject":{
            "type":"number",
            "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectActualsLineItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a project actual line 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 : projectActualsLineItem

Deprecated. As of 23.6.
The system-generated identifier of a line item.

Match All

Show Source

• object ApiEntityProjectActualsLineItem
  Title: ApiEntityProjectActualsLineItem

{
    "description":"<b>Deprecated.</b> As of <i>23.6</i>.</br>The system-generated identifier of a line item.",
    "deprecated":true,
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem"
        }
    ]
}

204 Response

Successful operation with no content.

404 Response

The requested project actuals line items do not exist or you do not have access to them.

Back to Top