Jump to

• Request
• Response
• Examples

Get all award budget versions

get

/fscmRestApi/resources/11.13.18.05/awardBudgets

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • CurrentBaselineAwardBudgetFinder: Finds the current baseline award budget for the specified award and financial plan type.
    Finder Variables:
    • AwardId; integer; Identifier of the award on which the budget is created.
    • FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
    • ProjectId; integer; Identifier of the project on which the award budget is created.
  • CurrentWorkingAwardBudgetFinder: Finds the current working award budget for the specified award and financial plan type.
    Finder Variables:
    • AwardId; integer; Identifier of the award on which the budget is created.
    • FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
    • ProjectId; integer; Identifier of the project on which the award budget is created.
  • PrimaryKey: Finds the award budget version.
    Finder Variables:
    • PlanVersionId; integer; Identifier of the award budget version.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AwardId; integer; Identifier of the award on which the budget is created.
  • AwardName; string; Name of the award on which the budget is created.
  • AwardNumber; string; Number of the award on which the budget is created.
  • FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
  • LockedBy; string; Name of the user who has locked the award budget version.
  • LockedFlag; boolean; Indicates if the award budget version is locked. A value of true means that the budget version is locked and can't be edited. A value of false means that the budget version is not locked and can be edited. The default value while creating an award budget version is false.
  • PlanVersionDescription; string; Plan version description for the award budget.
  • PlanVersionId; integer; Identifier of the award budget version.
  • PlanVersionName; string; Plan version name for the award budget.
  • PlanVersionNumber; integer; Plan version number for the award budget.
  • PlanVersionStatus; string; Plan version status for the award budget.
  • PlanningAmounts; string; The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately.
  • PlanningOptionId; integer; Unique identifier of the summary-level planning option in the award budget version.
  • ProjectId; integer; Identifier of the project on which the award budget is created.
  • ProjectName; string; Name of the project on which the award budget is created.
  • ProjectNumber; string; Number of the project on which the award budget is created.
  • RbsVersionId; integer; Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : awardBudgets

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object awardBudgets-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : awardBudgets-item-response

Type: object

Show Source

• AdministrativeCode: string
  Title: Administrative Code

  Identifies the action that an administrator can perform on the budget version based on specific requirements. Not to be used in typical implementations.
• Attachments: array Award Budget Attachments
  Title: Award Budget Attachments

  The Attachment resource is used to view, create, update, and delete attachments for award budgets.
• AwardId: integer (int64)
  Title: Award Identifier

  Identifier of the award on which the budget is created.
• AwardName: string
  Title: Award Name

  Maximum Length: 300

  Name of the award on which the budget is created.
• AwardNumber: string
  Title: Award Number

  Maximum Length: 120

  Number of the award on which the budget is created.
• BudgetCreationMethod: string
  Title: Budget Creation Method

  Value of the budget creation method. Valid values are: MANUAL, GENERATE, and COPY.
• BudgetGenerationSource: string
  Title: Budget Generation Source

  Value of the financial plan type to create a budget from an existing budget. Valid values are: Financial Plan Type and Project Plan Type.
• CopyAdjustmentPercentage: number
  Title: Adjustment Percentage

  Percentage value, either positive or negative, used to adjust the existing values when creating new version values.
• DeferFinancialPlanCreation: string
  Title: Defer Financial Plan Creation

  Default Value: Y

  Indicates that the budget version will be created in a deferred mode. Valid values are Y and N. The default value is Y. A value of Y means that the budget version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the budget version will be created in real time and included in the response of the POST operation.
• FinancialPlanType: string
  Title: Financial Plan Type

  Maximum Length: 240

  Name of the financial plan type used to create the award budget version.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockedBy: string
  Title: Locked By

  Read Only: true

  Maximum Length: 255

  Name of the user who has locked the award budget version.
• LockedFlag: boolean
  Title: Locked

  Indicates if the award budget version is locked. A value of true means that the budget version is locked and can't be edited. A value of false means that the budget version is not locked and can be edited. The default value while creating an award budget version is false.
• PCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Currency

  Read Only: true

  Budget burdened cost amounts in project currency for the award budget version.
• PCRawCostAmounts: number
  Title: Raw Cost in Project Currency

  Read Only: true

  Budget raw cost amounts in project currency for the award budget version.
• PCRevenueAmounts: number
  Title: Revenue in Project Currency

  Read Only: true

  Budget revenue amounts in project currency for the award budget version.
• PFCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Ledger Currency

  Read Only: true

  Budget burdened cost amounts in project ledger currency for the award budget version.
• PFCRawCostAmounts: number
  Title: Raw Cost in Project Ledger Currency

  Read Only: true

  Budget raw cost amounts in project ledger currency for the award budget version.
• PFCRevenueAmounts: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  Budget revenue amounts in project ledger currency for the award budget version.
• PlanningAmounts: string
  Title: Planning Amounts

  Maximum Length: 30

  The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately.
• PlanningOptionId: integer (int64)
  Title: Planning Option ID

  Read Only: true

  Unique identifier of the summary-level planning option in the award budget version.
• PlanningOptions: array Planning Options
  Title: Planning Options

  The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types.
• PlanningResources: array Planning Resources
  Title: Planning Resources

  The Planning resources is used to view, create, update, and delete an award budget line.
• PlanVersionDescription: string
  Title: Description

  Maximum Length: 2000

  Plan version description for the award budget.
• PlanVersionId: integer (int64)
  Title: Budget Version ID

  Read Only: true

  Identifier of the award budget version.
• PlanVersionName: string
  Title: Version Name

  Maximum Length: 225

  Plan version name for the award budget.
• PlanVersionNumber: integer (int64)
  Title: Version Number

  Read Only: true

  Plan version number for the award budget.
• PlanVersionStatus: string
  Title: Plan Version Status

  Plan version status for the award budget.
• ProjectId: integer (int64)
  Identifier of the project on which the award budget is created.
• ProjectName: string
  Title: Project Name

  Maximum Length: 240

  Name of the project on which the award budget is created.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Number of the project on which the award budget is created.
• RbsVersionId: integer (int64)
  Title: Resource Breakdown Structure Version ID

  Read Only: true

  Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data.
• SourcePlanType: string
  Title: Source Plan Type

  Name of the financial plan type to create a budget from an existing budget.
• SourcePlanVersionId: integer
  Title: Source Plan Version

  Identifier of the source plan version. The SourcePlanVersionId attributes takes precedence over all the other attributes such as generation source, plan type, and so on.
• SourcePlanVersionNumber: integer
  Number of the source plan version.
• SourcePlanVersionStatus: string
  Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline.
• VersionErrors: array Version Errors
  Title: Version Errors

  The Version Errors resource is used to view award budget version and award budget line errors.

{
    "type":"object",
    "properties":{
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project on which the award budget is created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourcePlanVersionNumber":{
            "type":"integer",
            "description":"Number of the source plan version.",
            "nullable":true,
            "x-queryable":false
        },
        "AdministrativeCode":{
            "title":"Administrative Code",
            "type":"string",
            "description":"Identifies the action that an administrator can perform on the budget version based on specific requirements. Not to be used in typical implementations.",
            "nullable":true,
            "x-queryable":false
        },
        "VersionErrors":{
            "title":"Version Errors",
            "type":"array",
            "description":"The Version Errors resource is used to view award budget version and award budget line errors.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-VersionErrors-item-response"
            }
        },
        "SourcePlanVersionStatus":{
            "type":"string",
            "description":"Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline.",
            "nullable":true,
            "x-queryable":false
        },
        "BudgetGenerationSource":{
            "title":"Budget Generation Source",
            "type":"string",
            "description":"Value of the financial plan type to create a budget from an existing budget. Valid values are: Financial Plan Type and Project Plan Type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CopyAdjustmentPercentage":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Percentage value, either positive or negative, used to adjust the existing values when creating new version values.",
            "nullable":true,
            "x-queryable":false
        },
        "PlanVersionDescription":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Plan version description for the award budget.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Award Budget Attachments",
            "type":"array",
            "description":"The Attachment resource is used to view, create, update, and delete attachments for award budgets.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-Attachments-item-response"
            }
        },
        "LockedBy":{
            "title":"Locked By",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the user who has locked the award budget version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PFCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"Budget burdened cost amounts in project ledger currency for the award budget version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanningAmounts":{
            "title":"Planning Amounts",
            "maxLength":"30",
            "type":"string",
            "description":"The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningOptionId":{
            "title":"Planning Option ID",
            "type":"integer",
            "description":"Unique identifier of the summary-level planning option in the award budget version.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PFCRawCostAmounts":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"Budget raw cost amounts in project ledger currency for the award budget version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"Budget burdened cost amounts in project currency for the award budget version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeferFinancialPlanCreation":{
            "title":"Defer Financial Plan Creation",
            "type":"string",
            "description":"Indicates that the budget version will be created in a deferred mode. Valid values are Y and N. The default value is Y. A value of Y means that the budget version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the budget version will be created in real time and included in the response of the POST operation.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "PCRawCostAmounts":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Budget raw cost amounts in project currency for the award budget version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FinancialPlanType":{
            "title":"Financial Plan Type",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the financial plan type used to create the award budget version.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AwardName":{
            "title":"Award Name",
            "maxLength":"300",
            "type":"string",
            "description":"Name of the award on which the budget is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "PlanningResources":{
            "title":"Planning Resources",
            "type":"array",
            "description":"The Planning resources is used to view, create, update, and delete an award  budget line.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-item-response"
            }
        },
        "PlanningOptions":{
            "title":"Planning Options",
            "type":"array",
            "description":"The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningOptions-item-response"
            },
            "x-cardinality":"1"
        },
        "PlanVersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Plan version number for the award budget.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Number of the project on which the award budget is created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanVersionId":{
            "title":"Budget Version ID",
            "type":"integer",
            "description":"Identifier of the award budget version.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Identifier of the project on which the award budget is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award Identifier",
            "type":"integer",
            "description":"Identifier of the award on which the budget is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanVersionName":{
            "title":"Version Name",
            "maxLength":"225",
            "type":"string",
            "description":"Plan version name for the award budget.",
            "nullable":false,
            "x-queryable":true
        },
        "SourcePlanVersionId":{
            "title":"Source Plan Version",
            "type":"integer",
            "description":"Identifier of the source plan version. The SourcePlanVersionId attributes takes precedence over all the other attributes such as generation source, plan type, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "LockedFlag":{
            "title":"Locked",
            "type":"boolean",
            "description":"Indicates if the award budget version is locked. A value of true means that the budget version is locked and can't be edited. A value of false means that the budget version is not locked and can be edited. The default value while creating an award budget version is false.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardNumber":{
            "title":"Award Number",
            "maxLength":"120",
            "type":"string",
            "description":"Number of the award on which the budget is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "PlanVersionStatus":{
            "title":"Plan Version Status",
            "type":"string",
            "description":"Plan version status for the award budget.",
            "nullable":true,
            "x-queryable":true
        },
        "RbsVersionId":{
            "title":"Resource Breakdown Structure Version ID",
            "type":"integer",
            "description":"Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourcePlanType":{
            "title":"Source Plan Type",
            "type":"string",
            "description":"Name of the financial plan type to create a budget from an existing budget.",
            "nullable":true,
            "x-queryable":false
        },
        "PCRevenueAmounts":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"Budget revenue amounts in project currency for the award budget version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRevenueAmounts":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "description":"Budget revenue amounts in project ledger currency for the award budget version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BudgetCreationMethod":{
            "title":"Budget Creation Method",
            "type":"string",
            "description":"Value of the budget creation method. Valid values are: MANUAL, GENERATE, and COPY.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Award Budget Attachments

Type: array

Title: Award Budget Attachments

The Attachment resource is used to view, create, update, and delete attachments for award budgets.

Show Source

• Array of: object awardBudgets-Attachments-item-response

{
    "title":"Award Budget Attachments",
    "type":"array",
    "description":"The Attachment resource is used to view, create, update, and delete attachments for award budgets.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-Attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Planning Options

Type: array

Title: Planning Options

The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types.

Show Source

• Array of: object awardBudgets-PlanningOptions-item-response

{
    "title":"Planning Options",
    "type":"array",
    "description":"The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningOptions-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Planning Resources

Type: array

Title: Planning Resources

The Planning resources is used to view, create, update, and delete an award budget line.

Show Source

• Array of: object awardBudgets-PlanningResources-item-response

{
    "title":"Planning Resources",
    "type":"array",
    "description":"The Planning resources is used to view, create, update, and delete an award  budget line.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningResources-item-response"
    }
}

Nested Schema : Version Errors

Type: array

Title: Version Errors

The Version Errors resource is used to view award budget version and award budget line errors.

Show Source

• Array of: object awardBudgets-VersionErrors-item-response

{
    "title":"Version Errors",
    "type":"array",
    "description":"The Version Errors resource is used to view award budget version and award budget line errors.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-VersionErrors-item-response"
    }
}

Nested Schema : awardBudgets-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : awardBudgets-PlanningOptions-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningOptionId: integer (int64)
  Title: Planning Option ID

  Unique identifier of the summary-level planning option in the award budget version.
• PlanningOptionsDFF: array Planning Options Descriptive Flexfields
  Title: Planning Options Descriptive Flexfields

  A listing of all the descriptive flexfields available for planning options in award budget versions.

{
    "type":"object",
    "properties":{
        "PlanningOptionsDFF":{
            "title":"Planning Options Descriptive Flexfields",
            "type":"array",
            "description":"A listing of all the descriptive flexfields available for planning options in award budget versions.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningOptions-PlanningOptionsDFF-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningOptionId":{
            "title":"Planning Option ID",
            "type":"integer",
            "description":"Unique identifier of the summary-level planning option in the award budget version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Planning Options Descriptive Flexfields

Type: array

Title: Planning Options Descriptive Flexfields

A listing of all the descriptive flexfields available for planning options in award budget versions.

Show Source

• Array of: object awardBudgets-PlanningOptions-PlanningOptionsDFF-item-response

{
    "title":"Planning Options Descriptive Flexfields",
    "type":"array",
    "description":"A listing of all the descriptive flexfields available for planning options in award budget versions.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningOptions-PlanningOptionsDFF-item-response"
    }
}

Nested Schema : awardBudgets-PlanningOptions-PlanningOptionsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Code that identifies the context for the segments of the planning options flexfields.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Name of the context for the segments of the planning options flexfields.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningOptionId: integer (int64)
  Unique identifier of the summary-level planning option in the award budget version.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Name of the context for the segments of the planning options flexfields.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "PlanningOptionId":{
            "type":"integer",
            "description":"Unique identifier of the summary-level planning option in the award budget version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the context for the segments of the planning options flexfields.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : awardBudgets-PlanningResources-item-response

Type: object

Show Source

• FundingSourceId: integer (int64)
  Identifier of the funding source used to create the award budget line.
• FundingSourceName: string
  Title: Funding Source Name

  Maximum Length: 360

  Funding Source Name used to create the award budget line.
• FundingSourceNumber: string
  Title: Funding Source Number

  Maximum Length: 50

  Funding Source Number used to create the award budget line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningAmounts: array Planning Amounts
  Title: Planning Amounts

  The Planning Amounts resource is used to view, create, and delete an award budget line amounts.
• PlanningElementId: integer (int64)
  Title: Planning Element ID

  Identifier of the award budget line.
• PlanningEndDate: string (date-time)
  Title: Planning Dates: To Date

  Award budget line end date.
• PlanningStartDate: string (date-time)
  Title: Planning Dates: From Date

  Award budget line start date.
• RbsElementId: integer (int64)
  Identifier of the resource used to create the award budget line.
• ResourceName: string
  Title: Resource Name

  Maximum Length: 240

  The name of the resource used to create the award budget line.
• TaskId: integer (int64)
  Identifier of the task which is used to create a award budget line.
• TaskName: string
  Title: Task Name

  Maximum Length: 255

  Name of the task which is used to create a award budget line.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task which is used to create a award budget line.
• UnitOfMeasure: string
  Read Only: true

  The units, such as hours and days, used for measuring the work or effort that is planned for a resource on a budget line.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "type":"integer",
            "description":"Identifier of the task which is used to create a award budget line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"The units, such as hours and days, used for measuring the work or effort that is planned for a resource on a budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the resource used to create the award budget line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the task which is used to create a award budget line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanningElementId":{
            "title":"Planning Element ID",
            "type":"integer",
            "description":"Identifier of the award budget line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanningEndDate":{
            "title":"Planning Dates: To Date",
            "type":"string",
            "description":"Award budget line end date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RbsElementId":{
            "type":"integer",
            "description":"Identifier of the resource used to create the award budget line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingSourceName":{
            "title":"Funding Source Name",
            "maxLength":"360",
            "type":"string",
            "description":"Funding Source Name used to create the award budget line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FundingSourceId":{
            "type":"integer",
            "description":"Identifier of the funding source used to create the award budget line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingSourceNumber":{
            "title":"Funding Source Number",
            "maxLength":"50",
            "type":"string",
            "description":"Funding Source Number used to create the award budget line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanningAmounts":{
            "title":"Planning Amounts",
            "type":"array",
            "description":"The Planning Amounts resource is used to view, create, and delete an award budget line amounts.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-item-response"
            }
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task which is used to create a award budget line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanningStartDate":{
            "title":"Planning Dates: From Date",
            "type":"string",
            "description":"Award budget line start date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Planning Amounts

Type: array

Title: Planning Amounts

The Planning Amounts resource is used to view, create, and delete an award budget line amounts.

Show Source

• Array of: object awardBudgets-PlanningResources-PlanningAmounts-item-response

{
    "title":"Planning Amounts",
    "type":"array",
    "description":"The Planning Amounts resource is used to view, create, and delete an award budget line amounts.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-item-response"
    }
}

Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-item-response

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Read Only: true

  Award budget line burdened cost amounts in transaction currency.
• Currency: string
  Maximum Length: 15

  Currency code for the award budget lines.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost: Effective Rate

  Read Only: true

  Effective burdened cost rate for award budget line.
• EffectiveRawCostRate: number
  Title: Effective Raw Cost Rate

  Read Only: true

  Effective raw cost rate for award budget line.
• EffectiveRevenueRate: number
  Title: Effective Revenue Rate

  Read Only: true

  Effective revenue rate for award budget line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Currency

  Read Only: true

  Award budget line burdened cost amounts in project currency.
• PCRawCostAmounts: number
  Title: Raw Cost in Project Currency

  Read Only: true

  Award budget line raw cost amounts in project currency.
• PCRevenueAmounts: number
  Title: Revenue in Project Currency

  Read Only: true

  Award budget line revenue amounts in project currency.
• PFCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Ledger Currency

  Read Only: true

  Award budget line burdened cost amounts in project ledger currency.
• PFCRawCostAmounts: number
  Title: Raw Cost in Project Ledger Currency

  Read Only: true

  Award budget line raw cost amounts in project ledger currency.
• PFCRevenueAmounts: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  Award budget line revenue amounts in project ledger currency.
• PlanLineId: integer (int64)
  Title: Plan Line ID

  Identifier of the award budget line amounts.
• PlanLinesDFF: array Plan Lines Descriptive Flexfields
  Title: Plan Lines Descriptive Flexfields

  The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.
• PlanningAmountDetails: array Planning Amount Details
  Title: Planning Amount Details

  The Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts.
• Quantity: number
  Title: Quantity

  Read Only: true

  Measure of the effort planned for the award budget line.
• RawCostAmounts: number
  Title: Raw Cost

  Read Only: true

  Award budget line raw cost amounts in transaction currency.
• RevenueAmounts: number
  Title: Revenue

  Read Only: true

  Award budget line revenue amounts in transaction currency.
• StandardBurdenedCostRate: number
  Title: Standard Burdened Cost Rate

  Read Only: true

  Standard burdened cost rate for award budget line.
• StandardRawCostRate: number
  Title: Standard Raw Cost Rate

  Read Only: true

  Standard raw cost rate for award budget line.
• StandardRevenueRate: number
  Title: Standard Revenue Rate

  Read Only: true

  Standard revenue rate for award budget line.

{
    "type":"object",
    "properties":{
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Award budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanLineId":{
            "title":"Plan Line ID",
            "type":"integer",
            "description":"Identifier of the award budget line amounts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanningAmountDetails":{
            "title":"Planning Amount Details",
            "type":"array",
            "description":"The Planning Amount Details resource is used to view, create, and update an award  budget line periodic amounts.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Award budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardBurdenedCostRate":{
            "title":"Standard Burdened Cost Rate",
            "type":"number",
            "description":"Standard burdened cost rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Award budget line revenue amounts in transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Effective raw cost rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"Award budget line burdened cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardRawCostRate":{
            "title":"Standard Raw Cost Rate",
            "type":"number",
            "description":"Standard raw cost rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanLinesDFF":{
            "title":"Plan Lines Descriptive Flexfields",
            "type":"array",
            "description":"The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.",
            "items":{
                "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for the award budget lines.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardRevenueRate":{
            "title":"Standard Revenue Rate",
            "type":"number",
            "description":"Standard revenue rate for award budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRawCostAmounts":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"Award budget line raw cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"Award budget line burdened cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PCRevenueAmounts":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"Award budget line revenue amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PCRawCostAmounts":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Award budget line raw cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRevenueAmounts":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "description":"Award budget line revenue amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Plan Lines Descriptive Flexfields

Type: array

Title: Plan Lines Descriptive Flexfields

The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.

Show Source

• Array of: object awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response

{
    "title":"Plan Lines Descriptive Flexfields",
    "type":"array",
    "description":"The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Planning Amount Details

Type: array

Title: Planning Amount Details

The Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts.

Show Source

• Array of: object awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response

{
    "title":"Planning Amount Details",
    "type":"array",
    "description":"The Planning Amount Details resource is used to view, create, and update an award  budget line periodic amounts.",
    "items":{
        "$ref":"#/components/schemas/awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response"
    }
}

Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Code that identifies the context for the segments of the plan lines flexfields.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Name of the context for the segments of the plan lines flexfields.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanLineId: integer (int64)
  Identifier of the summary level planning amounts for a plan line in the award budget.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanLineId":{
            "type":"integer",
            "description":"Identifier of the summary level planning amounts for a plan line in the award budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Name of the context for the segments of the plan lines flexfields.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the context for the segments of the plan lines flexfields.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response

Type: object

Show Source

• BurdenedCostAmounts: number
  Title: Burdened Cost

  Periodic award budget line burdened cost amounts in transaction currency.
• EffectiveBurdenedCostRate: number
  Title: Burdened Cost: Effective Rate

  Effective burdened cost rate for periodic line.
• EffectiveRawCostRate: number
  Title: Effective Raw Cost Rate

  Effective raw cost rate for periodic line.
• EffectiveRevenueRate: number
  Title: Effective Revenue Rate

  Effective revenue rate for periodic line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Currency

  Read Only: true

  Periodic award budget line burdened cost amounts in project currency.
• PCRawCostAmounts: number
  Title: Raw Cost in Project Currency

  Read Only: true

  Periodic award budget line raw cost amounts in project currency.
• PCRevenueAmounts: number
  Title: Revenue in Project Currency

  Read Only: true

  Periodic award budget line revenue amounts in project currency.
• PeriodName: string
  Maximum Length: 30

  Period for which the periodic budget amount is entered.
• PFCBurdenedCostAmounts: number
  Title: Burdened Cost in Project Ledger Currency

  Read Only: true

  Periodic award budget line burdened cost amounts in project ledger currency.
• PFCRawCostAmounts: number
  Title: Raw Cost in Project Ledger Currency

  Read Only: true

  Periodic award budget line raw cost amounts in project ledger currency.
• PFCRevenueAmounts: number
  Title: Revenue in Project Ledger Currency

  Read Only: true

  Periodic award budget line revenue amounts in project ledger currency.
• PlanLineDetailId: integer (int64)
  Title: Plan Line Details ID

  Identifier of the award budget periodic amounts.
• Quantity: number
  Title: Quantity

  Measure of the effort planned for the award budget line by period.
• RawCostAmounts: number
  Title: Raw Cost

  Periodic award budget line raw cost amounts in transaction currency.
• RevenueAmounts: number
  Title: Revenue

  Periodic award budget line revenue amounts in transaction currency.
• StandardBurdenedCostRate: number
  Title: Standard Burdened Cost Rate

  Read Only: true

  Standard burdened cost rate for periodic line.
• StandardRawCostRate: number
  Title: Standard Raw Cost Rate

  Read Only: true

  Standard raw cost rate for periodic line.
• StandardRevenueRate: number
  Title: Standard Revenue Rate

  Read Only: true

  Standard revenue rate for periodic line.

{
    "type":"object",
    "properties":{
        "EffectiveRevenueRate":{
            "title":"Effective Revenue Rate",
            "type":"number",
            "description":"Effective revenue rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "RawCostAmounts":{
            "title":"Raw Cost",
            "type":"number",
            "description":"Periodic award budget line raw cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Measure of the effort planned for the award budget line by period.",
            "nullable":true,
            "x-queryable":false
        },
        "BurdenedCostAmounts":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"Periodic award budget line burdened cost amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardBurdenedCostRate":{
            "title":"Standard Burdened Cost Rate",
            "type":"number",
            "description":"Standard burdened cost rate for periodic line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"Periodic award budget line burdened cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevenueAmounts":{
            "title":"Revenue",
            "type":"number",
            "description":"Periodic award budget line revenue amounts in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveRawCostRate":{
            "title":"Effective Raw Cost Rate",
            "type":"number",
            "description":"Effective raw cost rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "StandardRawCostRate":{
            "title":"Standard Raw Cost Rate",
            "type":"number",
            "description":"Standard raw cost rate for periodic line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardRevenueRate":{
            "title":"Standard Revenue Rate",
            "type":"number",
            "description":"Standard revenue rate for periodic line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRawCostAmounts":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"Periodic award budget line raw cost amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveBurdenedCostRate":{
            "title":"Burdened Cost: Effective Rate",
            "type":"number",
            "description":"Effective burdened cost rate for periodic line.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PCBurdenedCostAmounts":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"Periodic award budget line burdened cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodName":{
            "maxLength":"30",
            "type":"string",
            "description":"Period for which the periodic budget amount is entered.",
            "nullable":true,
            "x-queryable":true
        },
        "PCRevenueAmounts":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"Periodic award budget line revenue amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanLineDetailId":{
            "title":"Plan Line Details ID",
            "type":"integer",
            "description":"Identifier of the award budget periodic amounts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PCRawCostAmounts":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Periodic award budget line raw cost amounts in project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PFCRevenueAmounts":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "description":"Periodic award budget line revenue amounts in project ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : awardBudgets-VersionErrors-item-response

Type: object

Show Source

• ErrorType: string
  Title: Rejection Type

  Read Only: true

  Maximum Length: 30

  Specifies whether a warning or error.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageCause: string
  Title: Cause

  Read Only: true

  Maximum Length: 4000

  Explanation for the reason of an error or warning message.
• MessageName: string
  Title: Message Name

  Read Only: true

  Maximum Length: 30

  Message code for the issue encountered.
• MessageText: string
  Title: Message Text

  Read Only: true

  Maximum Length: 240

  Error or warning that occurs or information that informs users, to know what action to take or to understand what is happening.
• MessageUserAction: string
  Title: Action

  Read Only: true

  Maximum Length: 4000

  States the response that end users must perform to continue and complete their tasks in response to an error or warning message.
• MessageUserDetails: string
  Title: Additional Details

  Read Only: true

  Maximum Length: 4000

  More detailed explanation of message text that states why the message occurred.
• PeriodName: string
  Title: Period

  Read Only: true

  Maximum Length: 30

  Period for which the periodic budget amount is entered.
• PlanVersionId: number
  Title: Plan Version

  Read Only: true

  Identifier of the project budget version.
• ResourceName: string
  Title: Resource

  Read Only: true

  Maximum Length: 240

  The name of the resource used to create the budget line.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  Name of the task which is used to create a budget line.
• TaskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  Number of the task which is used to create a budget line.
• TransactionCurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  Currency code for the budget lines.

{
    "type":"object",
    "properties":{
        "ResourceName":{
            "title":"Resource",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the resource used to create the budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanVersionId":{
            "title":"Plan Version",
            "type":"number",
            "description":"Identifier of the project budget version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the task which is used to create a budget line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageUserDetails":{
            "title":"Additional Details",
            "maxLength":"4000",
            "type":"string",
            "description":"More detailed explanation of message text that states why the message occurred.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageUserAction":{
            "title":"Action",
            "maxLength":"4000",
            "type":"string",
            "description":"States the response that end users must perform to continue and complete their tasks in response to an error or warning message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageText":{
            "title":"Message Text",
            "maxLength":"240",
            "type":"string",
            "description":"Error or warning that occurs or information that informs users, to know what action to take or to understand what is happening.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionCurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for the budget lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":"30",
            "type":"string",
            "description":"Message code for the issue encountered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCause":{
            "title":"Cause",
            "maxLength":"4000",
            "type":"string",
            "description":"Explanation for the reason of an error or warning message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorType":{
            "title":"Rejection Type",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies whether a warning or error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task which is used to create a budget line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":"30",
            "type":"string",
            "description":"Period for which the periodic budget amount is entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

adjustForRangeOfProjects

Operation: /fscmRestApi/resources/11.13.18.05/awardBudgets/action/adjustForRangeOfProjects

Adjusts the award budget version for the range of projects using the adjustment type and adjustment percentage.

refreshRatesForRangeOfProjects

Operation: /fscmRestApi/resources/11.13.18.05/awardBudgets/action/refreshRatesForRangeOfProjects

Refresh rates for the award budget version for the range of projects from the rate schedules.

reprocessFailedAwardBudgets

Operation: /fscmRestApi/resources/11.13.18.05/awardBudgets/action/reprocessFailedAwardBudgets

This action will reprocess all the award budget versions which are showing as failed and bring them back to working state.

Back to Top

Examples

The following example shows how to get all award budgets version for an award by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets

Response Body Example

The following shows an example of the response body in JSON format.

"{
    ""items"": [
        {
            ""FinancialPlanType"": ""QC Award Cost Budget - Budgetary Control (Approved)"",
            ""PlanningAmounts"": ""COST"",
            ""PlanVersionId"": 300100104145060,
            ""PlanVersionNumber"": 1,
            ""PlanVersionName"": ""Version 1"",
            ""PlanVersionDescription"": null,
            ""PlanVersionStatus"": ""Current and Original Baseline"",
            ""AwardId"": 300100090708661,
            ""AwardNumber"": ""PRE_REL13_EXP_A2"",
            ""AwardName"": ""PRE_REL13_EXP_A2"",
            ""ProjectId"": 300100104135179,
            ""ProjectNumber"": ""PRE_REL13_EXP_A2_P1"",
            ""ProjectName"": ""PRE_REL13_EXP_A2_P1"",
            ""BudgetCreationMethod"": null,
            ""SourcePlanVersionId"": null,
            ""BudgetGenerationSource"": null,
            ""SourcePlanType"": null,
            ""SourcePlanVersionStatus"": null,
            ""SourcePlanVersionNumber"": null,
            ""CopyAdjustmentPercentage"": null,
            ""PCRawCostAmounts"": 100000,
            ""PCBurdenedCostAmounts"": 100000,
            ""PCRevenueAmounts"": 0,
            ""PFCRawCostAmounts"": 100000,
            ""PFCBurdenedCostAmounts"": 100000,
            ""PFCRevenueAmounts"": 0,
            ""DeferFinancialPlanCreation"": null,
            ""AdministrativeCode"": null
        },
        {
            ""FinancialPlanType"": ""QC Award Cost Budget - Budgetary Control (Approved)"",
            ""PlanningAmounts"": ""COST"",
            ""PlanVersionId"": 100100052933323,
            ""PlanVersionNumber"": 2,
            ""PlanVersionName"": ""Version 2"",
            ""PlanVersionDescription"": null,
            ""PlanVersionStatus"": ""Current Working"",
            ""AwardId"": 300100090708661,
            ""AwardNumber"": ""PRE_REL13_EXP_A2"",
            ""AwardName"": ""PRE_REL13_EXP_A2"",
            ""ProjectId"": 300100104135179,
            ""ProjectNumber"": ""PRE_REL13_EXP_A2_P1"",
            ""ProjectName"": ""PRE_REL13_EXP_A2_P1"",
            ""BudgetCreationMethod"": null,
            ""SourcePlanVersionId"": null,
            ""BudgetGenerationSource"": null,
            ""SourcePlanType"": null,
            ""SourcePlanVersionStatus"": null,
            ""SourcePlanVersionNumber"": null,
            ""CopyAdjustmentPercentage"": null,
            ""PCRawCostAmounts"": 100000,
            ""PCBurdenedCostAmounts"": 100000,
            ""PCRevenueAmounts"": 0,
            ""PFCRawCostAmounts"": 100000,
            ""PFCBurdenedCostAmounts"": 100000,
            ""PFCRevenueAmounts"": 0,
            ""DeferFinancialPlanCreation"": null,
            ""AdministrativeCode"": null
        }
    ],
    ""count"": 2,
    ""hasMore"": false,
    ""limit"": 25,
    ""offset"": 0,
    ""links"": [
        {
            ""rel"": ""self"",
            ""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/awardBudgets"",
            ""name"": ""awardBudgets"",
            ""kind"": ""collection""
        }
    ]
}"

Back to Top