Get all planning resources for an award budget version
get
/fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the award budget version.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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:- PrimaryKey: Finds the award budget line.
Finder Variables:- PlanningElementId; integer; Identifier of the award budget line.
- PrimaryKey: Finds the award budget line.
-
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:- FundingSourceId; integer; Identifier of the funding source used to create the award budget line.
- FundingSourceName; string; Funding Source Name used to create the award budget line.
- FundingSourceNumber; string; Funding Source Number used to create the award budget line.
- PlanningElementId; integer; Identifier of the award budget line.
- PlanningEndDate; string; Award budget line end date.
- PlanningStartDate; string; Award budget line start date.
- RbsElementId; integer; Identifier of the resource used to create the award budget line.
- ResourceName; string; The name of the resource used to create the award budget line.
- TaskId; integer; Identifier of the task which is used to create a award budget line.
- TaskName; string; Name of the task which is used to create a award budget line.
- TaskNumber; string; Number of the task which is used to create a award budget line.
- UnitOfMeasure; string; The units, such as hours and days, used for measuring the work or effort that is planned for a resource on a budget line.
-
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 TopResponse
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.
Root Schema : awardBudgets-PlanningResources
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awardBudgets-PlanningResources-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get an award budget 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/300100104145060/child/PlanningResources
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "TaskId": 300100104135183, "TaskNumber": "PRE_REL13_EXP_A2_P1", "TaskName": "PRE_REL13_EXP_A2_P1", "RbsElementId": 300100038787351, "ResourceName": "Supplies and Travel", "PlanningStartDate": "2013-10-01T00:00:00+00:00", "PlanningEndDate": "2018-10-30T00:00:00+00:00", "FundingSourceId": 300100038787369, "FundingSourceNumber": "CDRM_70255", "FundingSourceName": "Dept of Health and Human Services (DHHS)" }, { "TaskId": 300100104135183, "TaskNumber": "PRE_REL13_EXP_A2_P1", "TaskName": "PRE_REL13_EXP_A2_P1", "RbsElementId": 300100038787348, "ResourceName": "Chargebacks", "PlanningStartDate": "2013-10-01T00:00:00+00:00", "PlanningEndDate": "2018-10-30T00:00:00+00:00", "FundingSourceId": 300100038787369, "FundingSourceNumber": "CDRM_70255", "FundingSourceName": "Dept of Health and Human Services (DHHS)" }, { "TaskId": 300100104135183, "TaskNumber": "PRE_REL13_EXP_A2_P1", "TaskName": "PRE_REL13_EXP_A2_P1", "RbsElementId": 300100038787345, "ResourceName": "Salary", "PlanningStartDate": "2013-10-01T00:00:00+00:00", "PlanningEndDate": "2018-10-30T00:00:00+00:00", "FundingSourceId": 300100038787369, "FundingSourceNumber": "CDRM_70255", "FundingSourceName": "Dept of Health and Human Services (DHHS)" }, { "TaskId": 300100104135183, "TaskNumber": "PRE_REL13_EXP_A2_P1", "TaskName": "PRE_REL13_EXP_A2_P1", "RbsElementId": 300100038787339, "ResourceName": "Burden Expenses", "PlanningStartDate": "2013-10-01T00:00:00+00:00", "PlanningEndDate": "2018-10-30T00:00:00+00:00", "FundingSourceId": 300100038787369, "FundingSourceNumber": "CDRM_70255", "FundingSourceName": "Dept of Health and Human Services (DHHS)" } ], "count": 4, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/awardBudgets/300100104145060/child/PlanningResources", "name": "PlanningResources", "kind": "collection" } ] }