1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. List of Values
  4. LOV for Award Templates

Get all award templates

get

/fscmRestApi/resources/11.13.18.05/awardTemplatesLOV

Request

Query Parameters
  • 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).
  • 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
  • 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

    • ActiveTemplatesFinder Finds award templates valid for the current date.
      Finder Variables
      • KeywordFinder Finds the award templates that match with the specified keyword.
        Finder Variables
        • SearchTerm; string; The identifier of the keyword finder variable for searching award templates with certain keyword values.
      • NonCostShareFinder Finds the award templates that don't have cost share.
        Finder Variables
        • PrimaryKey Finds the award template with the specified primary key.
          Finder Variables
          • TemplateId; integer; The identifier of the award template used in the primary key finder.
      • 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.
      • 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
      • 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.
      • The resource item payload will be filtered in order to contain only data (no links section, for example).
      • 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
      • 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:
        • AwardOwningOrgId; integer; The identifier of the organization that owns the award template.
        • AwardOwningOrgName; string; The name of the organization that owns the award template.
        • AwardPurposeCode; string; The purpose code of the award template.
        • AwardType; string; The award type of the award template.
        • BudgetPeriodCount; integer; The count of the budget period of the award template.
        • BudgetPeriodFormat; string; The format of the budget period of the award template.
        • BudgetPeriodFrequency; string; The frequency of the budget period of the award template.
        • BudgetPeriodPrefix; string; The prefix of the budget period of the award template.
        • BudgetPeriodSeparator; string; The separator of the budget period of the award template.
        • BudgetaryControlFlag; boolean; Indicates whether the award template is enabled for budgetary control.
        • BusinessUnitId; integer; The identifier of the business unit of the award template.
        • BusinessUnitName; string; The name of the business unit of the award template.
        • ContractApprovalFlag; boolean; Indicates whether the award template contract should be sent for approval.
        • CostShareFlag; boolean; Indicates whether the award template has a cost share component.
        • CurrencyCode; string; The currency code of the award template.
        • DefaultContractTypeId; integer; The identifier of the default contract type of the award template.
        • DefaultContractTypeName; string; The name of the default contract type of the award template.
        • DefaultInterCompanyFlag; boolean; Indicates whether the award template is setup for intercompany transactions.
        • DefaultTemplateFlag; boolean; Indicates whether the award template should be used as the default in the Quick Create Award process.
        • Description; string; The description of the award template.
        • EndDateActive; string; The active end date of the award template.
        • FederalFlag; boolean; Indicates whether the award template is from a federal sponsor.
        • LegalEntityId; integer; The identifier of the legal entity of the award template.
        • LocEnabledFlag; boolean; Indicates whether the award template is enabled for letter of credit billing.
        • MulticurrencyFlag; boolean; Indicates whether the award template is set for multiple currencies.
        • PartyId; integer; The identifier of the party of the award template.
        • PartyName; string; The name of the party of the award template.
        • PrincipalInvestigatorId; integer; The identifier of the principal investigator of the award template.
        • PrincipalInvestigatorName; string; The name of the principal investigator of the award template.
        • ProjectTemplateId; integer; The identifier of the project template of the award template.
        • ProjectTemplateName; string; The name of the project template of the award template.
        • ProjectTemplateNumber; string; The number of the project template of the award template.
        • SponsorAwardNumber; string; The sponsor award number of the award template.
        • SponsorId; integer; The identifier of the sponsor of the award template.
        • StartDateActive; string; The active start date of the award template.
        • TemplateId; integer; The identifier of the award template.
        • TemplateName; string; The name of the award template.
        • TemplateNumber; string; The number of the award template.
        • TemplateSource; string; The source of the award template.
      • 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
      • 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".
      • 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

      Default Response

      The following table describes the default response for this task.
      Headers
      • 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".
      • 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 : awardTemplatesLOV
      Type: object
      Show Source
      Nested Schema : Items
      Type: array
      Title: Items
      The items in the collection.
      Show Source
      Nested Schema : awardTemplatesLOV-item-response
      Type: object
      Show Source
      Back to Top

      Examples

      The following example shows how to get all the LOVs for all the Project Billing Event Types 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/awardTemplatesLOV

      Response Body Example

      The following shows an example of the response body in JSON format of all the LOVs for all the Award Templates.

      {
  "items": [
    {
      "TemplateId": 300100043492097,
      "TemplateNumber": "Demo Award Template",
      "TemplateName": "Demo Award Template",
      "StartDateActive": "2013-10-01",
      "EndDateActive": "2018-09-30",
      "Description": null,
      "CurrencyCode": "USD",
      "BudgetPeriodCount": 5,
      "BudgetPeriodFrequency": "Yearly",
      "BudgetPeriodFormat": "YYYY",
      "BudgetPeriodPrefix": "FY-",
      "BudgetPeriodSeparator": "None",
      "ContractApprovalFlag": null,
      "DefaultTemplateFlag": null,
      "LegalEntityId": 300100014516903,
      "LocEnabledFlag": null,
      "TemplateSource": "NEW",
      "AwardType": "GRNT",
      "AwardPurposeCode": "BARE",
      "SponsorAwardNumber": null,
      "SponsorId": 300100038787368,
      "FederalFlag": true,
      "BudgetaryControlFlag": null,
      "ProjectTemplateId": null,
      "ProjectTemplateName": null,
      "ProjectTemplateNumber": null,
      "PartyId": 300100031628785,
      "PartyName": "Dept of Health and Human Services (DHHS)",
      "BusinessUnitId": 300100014554154,
      "BusinessUnitName": "Vision City Operations",
      "AwardOwningOrgId": 300100017216727,
      "AwardOwningOrgName": "Vision City Maintenance",
      "MulticurrencyFlag": false,
      "DefaultContractTypeId": 300100036628035,
      "DefaultContractTypeName": "Sell: Award Project lines",
      "DefaultInterCompanyFlag": false,
      "PrincipalInvestigatorName": null,
      "PrincipalInvestigatorId": null,
      "CostShareFlag": false,
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardTemplatesLOV/300100043492097",
          "name": "awardTemplatesLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardTemplatesLOV/300100043492097",
          "name": "awardTemplatesLOV",
          "kind": "item"
        }
      ]
    },
    {
      "TemplateId": 300100038787779,
      "TemplateNumber": "Fed_Aw_T_VCO",
      "TemplateName": "Federal Award Template_VCO",
      "StartDateActive": "2011-10-01",
      "EndDateActive": null,
      "Description": null,
      "CurrencyCode": "USD",
      "BudgetPeriodCount": 5,
      "BudgetPeriodFrequency": "Yearly",
      "BudgetPeriodFormat": "YY",
      "BudgetPeriodPrefix": "YrStartOct",
      "BudgetPeriodSeparator": "-",
      "ContractApprovalFlag": null,
      "DefaultTemplateFlag": null,
      "LegalEntityId": 300100014516903,
      "LocEnabledFlag": true,
      "TemplateSource": "NEW",
      "AwardType": null,
      "AwardPurposeCode": null,
      "SponsorAwardNumber": null,
      "SponsorId": 300100038787368,
      "FederalFlag": true,
      "BudgetaryControlFlag": null,
      "ProjectTemplateId": null,
      "ProjectTemplateName": null,
      "ProjectTemplateNumber": null,
      "PartyId": 300100031628785,
      "PartyName": "Dept of Health and Human Services (DHHS)",
      "BusinessUnitId": 300100014554154,
      "BusinessUnitName": "Vision City Operations",
      "AwardOwningOrgId": 300100014554154,
      "AwardOwningOrgName": "Vision City Operations",
      "MulticurrencyFlag": false,
      "DefaultContractTypeId": 300100036628035,
      "DefaultContractTypeName": "Sell: Award Project lines",
      "DefaultInterCompanyFlag": false,
      "PrincipalInvestigatorName": "phil Williams",
      "PrincipalInvestigatorId": 300100026354758,
      "CostShareFlag": true,
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardTemplatesLOV/300100038787779",
          "name": "awardTemplatesLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardTemplatesLOV/300100038787779",
          "name": "awardTemplatesLOV",
          "kind": "item"
        }
      ]
    }
	...
  ],
  "count": 22,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardTemplatesLOV",
      "name": "awardTemplatesLOV",
      "kind": "collection"
    }
  ]
}
      Back to Top