Jump to

• Request
• Response

Batch Update Project Actuals

put

/api/restapi/projectActuals/batch

Send a request to this endpoint to update one or more project actuals. For each JSON object provided in the request body, an application object with a matching ID value 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 : List<ApiEntityProjectActualsInput>

Type: array

Title: List<ApiEntityProjectActualsInput>

Show Source

• Array of: object ApiEntityProjectActualsInput
  Title: ApiEntityProjectActualsInput

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

  • projectActualsId
  • projectActualsCode,projectId
  • projectActualsCode,projectCode,workspaceCode

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

Nested Schema : ApiEntityProjectActualsInput

Type: object

Title: ApiEntityProjectActualsInput

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

• projectActualsId
• projectActualsCode,projectId
• projectActualsCode,projectCode,workspaceCode

Show Source

• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a company.
• companySourceId: string
  Maximum Length: 255

  The unique identifier of company data in an external source.
• configuredFields: array configuredFields
  The list of configured fields for a project actuals.
• currencyCode: string
  Minimum Length: 1

  Maximum Length: 3

  The user-specified identifier of a currency.
• currencyId: integer (int64)
  The system-generated identifier of the currency associated with the project actual.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Details about the project actual.
• effectiveDate: string (date-time)
  The date the actual is effective.
• fixedExchangeRate: number
  The exchange rate used to convert the Total Amount value from the record currency to the base currency.
• projectActualName(required): string
  Minimum Length: 1

  Maximum Length: 255

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

  Maximum Length: 60

  The unique identifier for an actual.
• projectActualsCost: projectActualsCost
  Deprecated. As of 25.8.
  An object containing cost fields in the form of key-value pairs.
• projectActualsId: integer (int64)
  The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• projectCompanyId: integer (int64)
  The name of the company associated with the actual.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• projectSourceId: string
  Maximum Length: 255

  The unique identifier of project data in an external source.
• sourceId: string
  Maximum Length: 255

  The unique identifier of project actual data in an external source.

  Example: coarse
• status: string
  Allowed Values: [ "PENDING", "CONFIRMED" ]

  That status of the actual. Valid values are Pending and Confirmed.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityProjectActualsInput",
    "required":[
        "projectActualName",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "currencyCode":{
            "maxLength":3,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"That status of the actual. Valid values are Pending and Confirmed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "CONFIRMED"
            ]
        },
        "fixedExchangeRate":{
            "type":"number",
            "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The name of the company associated with the actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsCost":{
            "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>An object containing cost fields in the form of key-value pairs.",
            "deprecated":true,
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput"
                }
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for an actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectSourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of project data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companySourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of company data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Details about the project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date the actual is effective.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a project actuals.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "companyName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of a company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The system-generated identifier of the currency associated with the project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of project actual data in an external source.",
            "example":"coarse",
            "exampleSetFlag":true,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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 ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.<ul><li>projectActualsId</li><li>projectActualsCode,projectId</li><li>projectActualsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a project actuals.

Show Source

• Array of: object ApiEntityProjectActualsConfiguredFieldValueInput
  Title: ApiEntityProjectActualsConfiguredFieldValueInput

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

  • projectActualsConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a project actuals.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectActualsCost

Deprecated. As of 25.8.
An object containing cost fields in the form of key-value pairs.

Match All

Deprecated. As of 25.8.
An object containing cost fields in the form of key-value pairs.

Show Source

• object ApiEntityProjectActualsCostInput
  Title: ApiEntityProjectActualsCostInput

{
    "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>An object containing cost fields in the form of key-value pairs.",
    "deprecated":true,
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput"
        }
    ]
}

Nested Schema : ApiEntityProjectActualsConfiguredFieldValueInput

Type: object

Title: ApiEntityProjectActualsConfiguredFieldValueInput

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

• projectActualsConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.
• projectActualsConfiguredFieldValueId: integer (int64)
  The unique identifier for the Project Actuals Configured Field.
• projectActualsId: integer (int64)
  The system-generated identifier for an Actual.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityProjectActualsConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "projectActualsId":{
            "type":"integer",
            "description":"The system-generated identifier for an Actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Project Actuals Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        }
    },
    "description":"This entity represents a ProjectActualsConfiguredFieldValue object, a unique ProjectActualsConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>projectActualsConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectActualsCostInput

Type: object

Title: ApiEntityProjectActualsCostInput

Show Source

• projectActuals: projectActuals
  The supporting details for the project actuals.
• projectActualsId: integer (int64)
  The unique identifier of project actual data.

{
    "title":"ApiEntityProjectActualsCostInput",
    "type":"object",
    "properties":{
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier of project actual data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActuals":{
            "description":"The supporting details for the project actuals. ",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsInput"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectActuals

The supporting details for the project actuals.

Match All

The supporting details for the project actuals.

Show Source

• object ApiEntityProjectActualsInput
  Title: ApiEntityProjectActualsInput

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

  • projectActualsId
  • projectActualsCode,projectId
  • projectActualsCode,projectCode,workspaceCode

{
    "description":"The supporting details for the project actuals. ",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsInput"
        }
    ]
}

Examples

Select an example Batch Update Project Actuals to Assign Configured Field Batch Update Project Actuals Using Project Actual IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Project Actuals with the specified ID does not exist or has been deleted.

Back to Top