Get all award funding sources
get
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFundingSource
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
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> -
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 an award funding source record with the specified id.
Finder Variables:- AwardFundingSourceSourceId; integer; Identifier of the award funding source.
- PrimaryKey: Finds an award funding source record with the specified id.
-
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:- ApprovalDate; string; The approval date of the selected award funding source.
- ApprovalPersonId; integer; The unique identifier of the person who approved the selected funding source.
- ApprovalPersonName; string; The name of the person who approved the selected funding source.
- ApprovalPersonNumber; string; The number of the person who approved the selected funding source.
- AwardFundingSourceSourceId; integer; The unique identifier of the award funding source association.
- AwardId; integer; The unique identifier of the award.
- CreatedBy; string; The user that created the award funding source.
- CreationDate; string; The date when the award funding source was created.
- FundingSourceId; integer; The unique identifier of the selected funding source.
- FundingSourceName; string; The name of the selected funding source.
- FundingSourceNumber; string; The unique number associated with the selected funding source.
- LastUpdateDate; string; The date when the award funding source was last updated.
- LastUpdatedBy; string; The user that last updated the award funding source.
- RequiredBySponsor; string; Indicates whether the selected funding source is marked as required by sponsor.
- Type; string; The type of the selected award funding source.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : awards-AwardFundingSource
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 : awards-AwardFundingSource-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date)
Title:
Approval Date
The approval date of the selected award funding source. -
ApprovalPersonId: integer
(int64)
Title:
Approved By
The unique identifier of the person who approved the selected funding source. -
ApprovalPersonName: string
Title:
Approved By
Maximum Length:240
The name of the person who approved the selected funding source. -
ApprovalPersonNumber: string
Title:
Approval Person Number
Maximum Length:30
The number of the person who approved the selected funding source. -
AwardFundingSourceSourceId: integer
(int64)
Title:
Award Funding Source ID
The unique identifier of the award funding source association. -
AwardId: integer
(int64)
Title:
Award ID
The unique identifier of the award. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award funding source. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award funding source was created. -
FundingSourceId: integer
(int64)
Title:
Funding Source ID
The unique identifier of the selected funding source. -
FundingSourceName: string
Title:
Name
Maximum Length:360
The name of the selected funding source. -
FundingSourceNumber: string
Title:
Number
Maximum Length:50
The unique number associated with the selected funding source. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award funding source was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award funding source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequiredBySponsor: string
Title:
Required By Sponsor
Maximum Length:1
Indicates whether the selected funding source is marked as required by sponsor. -
Type: string
Title:
Type
Read Only:true
Maximum Length:1
The type of the selected award funding source.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
The following example shows how to get all award funding sources 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/awards/300100043712585/child/AwardFundingSource
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "AwardFundingSourceSourceId": 300100043492129, "AwardId": 300100043712585, "FundingSourceId": 9999, "FundingSourceName": "Internal", "FundingSourceNumber": "Internal", "RequiredBySponsor": null, "ApprovalPersonId": null, "ApprovalPersonName": null, "ApprovalDate": null, "Type": "N", "CreatedBy": "Mark.Williams", "CreationDate": "2014-08-06T23:12:47.746+00:00", "LastUpdatedBy": "Mark.Williams", "LastUpdateDate": "2014-08-06T23:12:51.612+00:00" } ... ... }