Jump to

• Request
• Response

Update an Fund Actual

put

/api/restapi/fundActual

Send a request to this endpoint to update an fund actual. An application object with an ID value that matches the ID value provided in the JSON object in the request body 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 : 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.
• 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.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityFundActualInput",
    "required":[
        "fundId",
        "projectActualsId"
    ],
    "type":"object",
    "properties":{
        "fundActualId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The system-generated identifier of a project actual.",
            "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"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundActualCost":{
            "description":"The cost associated with the fund actual.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundActualCostInput"
                }
            ]
        },
        "projectActualsCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for an actual.",
            "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"
            ]
        }
    },
    "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

The cost associated with the fund actual.

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

• assignedCostProject: number (double)
  The portion of the fund that is assigned to the actual. This value is based on project currency.
• fundActualId: integer (int64)
  The system-generated identifier of a fund actual.

{
    "title":"ApiEntityFundActualCostInput",
    "type":"object",
    "properties":{
        "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 Update a Fund Actual Using Fund Actual ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

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

Back to Top