Jump to

• Request
• Response

View an Fund Actual

get

/api/restapi/fundActual/{fundActualId}

This endpoint returns fund actuals that meet the following requirements:

• The object is associated with a fund actual with an ID value that matches the value of the {fundActualId} path parameter.

Fund Actuals represent the funds allocated to Project Actuals.

Request

Path Parameters

• fundActualId(required): integer(int64)
  The system-generated identifier of a fund actual.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityFundActual

Type: object

Title: ApiEntityFundActual

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: integer (int64)
  The system-generated identifier of a fund.
• link: string (url)
  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: 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)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityFundActual",
    "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"
            ]
        },
        "fundActualCost":{
            "description":"The cost associated with the fund actual.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityFundActualCost"
                }
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : fundActualCost

The cost associated with the fund actual.

Match All

Show Source

• object ApiEntityFundActualCost
  Title: ApiEntityFundActualCost

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

Nested Schema : ApiEntityFundActualCost

Type: object

Title: ApiEntityFundActualCost

Show Source

• assignedCost: number (double)
  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)
  The portion of the fund that is assigned to the actual. This value is based on workspace1 currency.
• assignedCostWorkspace2: number (double)
  The portion of the fund that is assigned to the actual. This value is based on workspace2 currency.
• assignedCostWorkspace3: number (double)
  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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityFundActualCost",
    "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"
            ]
        },
        "assignedCost":{
            "type":"number",
            "description":"The portion of the fund that is assigned to the actual.",
            "format":"double",
            "exampleSetFlag":false
        },
        "assignedCostWorkspace1":{
            "type":"number",
            "description":"The portion of the fund that is assigned to the actual. This value is based on workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "assignedCostWorkspace2":{
            "type":"number",
            "description":"The portion of the fund that is assigned to the actual. This value is based on workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "assignedCostWorkspace3":{
            "type":"number",
            "description":"The portion of the fund that is assigned to the actual. This value is based on workspace3 currency.",
            "format":"double",
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested fund actual does not exist, or you do not have access to it.

Back to Top