Jump to

• Request
• Response

Batch Integrate Project Actuals Line Items with an External Data Source

post

/api/restapi/projectActualsLineItem/syncBatch

Send a request to this endpoint to create or update an integrated project actuals line items. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityExternallySourcedProjectActualsLineItemInput>

Type: array

Title: List<ApiEntityExternallySourcedProjectActualsLineItemInput>

Show Source

• Array of: object ApiEntityExternallySourcedProjectActualsLineItemInput
  Title: ApiEntityExternallySourcedProjectActualsLineItemInput

  This entity represents a ExternallySourcedProjectActualsLineItem object, a unique ExternallySourcedProjectActualsLineItem object can be identified by the following combinations of the fields.

  • projectActualsLineItemId
  • projectActualsLineItemCode,projectActualsId
  • projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode

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

Nested Schema : ApiEntityExternallySourcedProjectActualsLineItemInput

Type: object

Title: ApiEntityExternallySourcedProjectActualsLineItemInput

This entity represents a ExternallySourcedProjectActualsLineItem object, a unique ExternallySourcedProjectActualsLineItem object can be identified by the following combinations of the fields.

• projectActualsLineItemId
• projectActualsLineItemCode,projectActualsId
• projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode

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.
• lineItemType: string
  Allowed Values: [ "LUMP_SUM", "UNIT_PRICE" ]

  The type assigned to an actual line item.
• name(required): 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(required): 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(required): 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: number (double)
  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.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityExternallySourcedProjectActualsLineItemInput",
    "required":[
        "name",
        "projectActualsId",
        "projectActualsLineItemCost"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "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":"number",
            "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":"double",
            "exampleSetFlag":false
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of cost category associated with the project actual line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "lineItemType":{
            "type":"string",
            "description":"The type assigned to an actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "LUMP_SUM",
                "UNIT_PRICE"
            ]
        },
        "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"
            ]
        },
        "unitOfMeasureValue":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The value of a units of measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryAbbreviation":{
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"The abbreviated name of a cost category.",
            "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"
            ]
        },
        "projectActualsLineItemCost":{
            "description":"The cost fields associated with a line item.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCostInput"
                }
            ]
        },
        "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"
            ]
        },
        "cbsCodeSourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of CBS data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "description":"This entity represents a ExternallySourcedProjectActualsLineItem object, a unique ExternallySourcedProjectActualsLineItem object can be identified by the following combinations of the fields.<ul><li>projectActualsLineItemId</li><li>projectActualsLineItemCode,projectActualsId</li><li>projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode</li>",
    "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.",
    "writeOnly":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "writeOnly":true,
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectActualsLineItemCost

The cost fields associated with a line item.

Match All

The cost fields associated with a line item.

Show Source

• object ApiEntityProjectActualsLineItemCostInput
  Title: ApiEntityProjectActualsLineItemCostInput

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

Nested Schema : ApiEntityProjectActualsLineItemCostInput

Type: object

Title: ApiEntityProjectActualsLineItemCostInput

Show Source

• projectActualsLineItemId: integer (int64)
  The system-generated identifier of a project actual line item.
• totalProjectActuals(required): 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.
• 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.

{
    "title":"ApiEntityProjectActualsLineItemCostInput",
    "required":[
        "totalProjectActuals"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "projectActualsLineItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a project actual line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Create or Update a Project Actuals Line Item Using Project Actuals ID Create or Update a Project Actuals Line Item Using Codes

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : List<ApiEntityERPSyncApiResponse>

Type: array

Title: List<ApiEntityERPSyncApiResponse>

Show Source

• Array of: object ApiEntityERPSyncApiResponse
  Title: ApiEntityERPSyncApiResponse

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

Nested Schema : ApiEntityERPSyncApiResponse

Type: object

Title: ApiEntityERPSyncApiResponse

Show Source

• identifier: object identifier
  The unique identifier of the supported object returned based on the user input.
  This field can return any of the following entities determined based on the object for which the API call is invoked.
  Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• message: string
  Message is populated based on result of the operation.
  Success - Message will not be populated. Please refer the statusCode.
  Failure - Error message or reason for operation failure is populated.
  Warning - warning message is populated.
  The field is non-persistable and thus maximum length is not applicable.
• primaryKeyName: string
  The primary key field name associated with the integrated object.
  The field is non-persistable and thus maximum length is not applicable.
• primaryKeyValue: integer (int64)
  The unique identifier for the integrated object.
• sourceId: string
  Maximum Length: 255

  The unique identifier of the object in an external source.
• statusCode: integer (int32)
  The response code representing the state of the API operation.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityERPSyncApiResponse",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "primaryKeyName":{
            "type":"string",
            "description":"The primary key field name associated with the integrated object.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "primaryKeyValue":{
            "type":"integer",
            "description":"The unique identifier for the integrated object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the object in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "message":{
            "type":"string",
            "description":"Message is populated based on result of the operation.<br>Success - Message will not be populated. Please refer the statusCode.<br>Failure - Error message or reason for operation failure is populated.<br>Warning - warning message is populated.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "identifier":{
            "type":"object",
            "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.",
            "exampleSetFlag":false,
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ProjectIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CBSSheetCodeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceIdentifier",
                    "exampleSetFlag":false
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : identifier

Type: object

The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.

Match One Schema

Show Source

• object ProjectIdentifier
  Title: ProjectIdentifier
• object CBSSheetCodeIdentifier
  Title: CBSSheetCodeIdentifier
• object ResourceIdentifier
  Title: ResourceIdentifier

{
    "type":"object",
    "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.",
    "exampleSetFlag":false,
    "oneOf":[
        {
            "$ref":"#/components/schemas/ProjectIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CBSSheetCodeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceIdentifier",
            "exampleSetFlag":false
        }
    ]
}

Nested Schema : ProjectIdentifier

Type: object

Title: ProjectIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CBSSheetCodeIdentifier

Type: object

Title: CBSSheetCodeIdentifier

Show Source

• cbsCode: string
  Maximum Length: 60

  The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.
• cbsSheetCodeId: integer (int64)
  The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
• costSheetId: integer (int64)
  The unique identifier of a cost sheet.
• parentId: integer (int64)
  The system-generated identifier of a parent cost item in a cost sheet.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CBSSheetCodeIdentifier",
    "type":"object",
    "properties":{
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of a parent cost item in a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCode":{
            "maxLength":60,
            "type":"string",
            "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceIdentifier

Type: object

Title: ResourceIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ResourceIdentifier",
    "type":"object",
    "properties":{
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "resourceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid Input.

Back to Top