Get all award projects
get
/fscmRestApi/resources/11.13.18.05/awardProjects
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:- PrimaryKey: Finds an award project with the specified project ID.
Finder Variables:- AwardProjectId; integer; Identifier of the award project.
- PrimaryKey: Finds an award project with the specified project 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:- AwardId; integer; Internal identifier of the award.
- AwardName; string; Name of the award.
- AwardNumber; string; Number of the award.
- AwardProjectId; integer; Internal identifier of the award project.
- BurdenScheduleFixedDate; string; Specific date used to determine the right set of burden multipliers for the award project.
- BurdenScheduleId; integer; The unique identifier of the burden schedule.
- BurdenScheduleName; string; Name of the burden schedule assigned at the award project level.
- CreatedBy; string; The user that created the award project.
- CreationDate; string; The date when the award project was created.
- CurrencyCode; string; Currency code representing the award currency. The currency code is a three-letter ISO code.
- LastUpdateDate; string; The date when the award project was last updated.
- LastUpdatedBy; string; The user that last updated the award project.
- ProjectId; integer; Identifier of the award project.
- ProjectName; string; Name of the project associated with the award.
- ProjectNumber; string; Number of the project associated with the award.
-
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(required):
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(required):
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 : awardProjects
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 : awardProjects-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Internal identifier of the award. -
AwardName: string
Title:
Award Name
Read Only:true
Maximum Length:300
Name of the award. -
AwardNumber: string
Title:
Award Number
Read Only:true
Maximum Length:120
Number of the award. -
AwardProjectId: integer
(int64)
Title:
Award Project ID
Internal identifier of the award project. -
BurdenScheduleFixedDate: string
(date)
Title:
Fixed Date
Specific date used to determine the right set of burden multipliers for the award project. -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule ID
The unique identifier of the burden schedule. -
BurdenScheduleName: string
Title:
Burden Schedule
Maximum Length:30
Name of the burden schedule assigned at the award project level. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project was created. -
CurrencyCode: string
Title:
Currency
Currency code representing the award currency. The currency code is a three-letter ISO code. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the award project. -
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project associated with the award. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Number of the project associated with the award.
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 projects 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/awardProjects
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "AwardProjectId": 300100043916343, "AwardId": 300100047723874, "AwardName": "PJC_XCC_GMS_VCO_SL Award", "AwardNumber": "PJC_XCC_GMS_VCO_SL_A", "ProjectId": 300100043916333, "ProjectName": "PJC_XCC_GMS_VCO_SL_P1", "ProjectNumber": "PJC_XCC_GMS_VCO_SL_P1", "BurdenScheduleId": null, "BurdenScheduleName": null, "BurdenScheduleFixedDate": null, "CurrencyCode": "USD", "CreatedBy": "Mark.Williams", "LastUpdateDate": "2014-08-07T02:13:11.126+00:00", "CreationDate": "2014-08-07T02:12:18+00:00", "LastUpdatedBy": "Mark.Williams" }