Jump to

• Request
• Response

Batch Update Fund Actuals

put

/api/restapi/fundActual/batch

Send a request to this endpoint to update one or more fund 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<ApiEntityFundActualInput>

Type: array

Title: List<ApiEntityFundActualInput>

Show Source

• Array of: object ApiEntityFundActualInput
  Title: ApiEntityFundActualInput

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

  • fundActualId
  • fundId,projectActualsId
  • fundId,projectActualsCode,projectCode,workspaceCode
  • projectActualsId,fundCode,projectCode,workspaceCode
  • fundCode,projectActualsCode,projectCode,workspaceCode

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

Nested Schema : ApiEntityFundActualInput

Type: object

Title: ApiEntityFundActualInput

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

• fundActualId
• fundId,projectActualsId
• fundId,projectActualsCode,projectCode,workspaceCode
• projectActualsId,fundCode,projectCode,workspaceCode
• fundCode,projectActualsCode,projectCode,workspaceCode

Show Source

• fundActualCost: fundActualCost
  The cost associated with the fund actual.
• fundActualId: integer (int64)
  The system-generated identifier of a fund actual.
• fundCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of a fund.
• fundId(required): integer (int64)
  The system-generated identifier of a fund.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectActualsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for an actual.
• projectActualsId(required): integer (int64)
  The system-generated identifier of a project actual.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityFundActualInput",
    "required":[
        "fundId",
        "projectActualsId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundActualCost":{
            "description":"The cost associated with the fund actual.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundActualCostInput"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of a fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The system-generated identifier of a project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for an actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundActualId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a FundActual object, a unique FundActual object can be identified by the following combinations of the fields.<ul><li>fundActualId</li><li>fundId,projectActualsId</li><li>fundId,projectActualsCode,projectCode,workspaceCode</li><li>projectActualsId,fundCode,projectCode,workspaceCode</li><li>fundCode,projectActualsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : fundActualCost

The cost associated with the fund actual.

Match All

Show Source

• object ApiEntityFundActualCostInput
  Title: ApiEntityFundActualCostInput

{
    "description":"The cost associated with the fund actual.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityFundActualCostInput"
        }
    ]
}

Nested Schema : ApiEntityFundActualCostInput

Type: object

Title: ApiEntityFundActualCostInput

Show Source

• assignedCost: number (double)
  Read Only: true

  Deprecated. As of 24.5.
  The portion of the fund that is assigned to the actual.
• assignedCostProject: number (double)
  The portion of the fund that is assigned to the actual. This value is based on project currency.
• assignedCostWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 24.5.
  The portion of the fund that is assigned to the actual. This value is based on workspace1 currency.
• assignedCostWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 24.5.
  The portion of the fund that is assigned to the actual. This value is based on workspace2 currency.
• assignedCostWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 24.5.
  The portion of the fund that is assigned to the actual. This value is based on workspace3 currency.
• fundActualId: integer (int64)
  The system-generated identifier of a fund actual.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.

{
    "title":"ApiEntityFundActualCostInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The portion of the fund that is assigned to the actual.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "assignedCostWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The portion of the fund that is assigned to the actual. This value is based on workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "assignedCostWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The portion of the fund that is assigned to the actual. This value is based on workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "assignedCostWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The portion of the fund that is assigned to the actual. This value is based on workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "assignedCostProject":{
            "type":"number",
            "description":"The portion of the fund that is assigned to the actual. This value is based on project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundActualId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Fund Actuals Using Fund 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

Invalid input for the Fund Actual service. Verify the request contains valid data, then resubmit the request.

Back to Top