1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Requisition Preferences

Get all preferences

get

/fscmRestApi/resources/11.13.18.05/requisitionPreferences

Request

Query Parameters
  • 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
  • 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:

    • ActiveSSPPreferenceFinder: Finds the active preference of type Self Service Procurement for the logged in user according to the user's requisition preferences.
      Finder Variables:
      • PersonId; integer; Value that uniquely identifies the user for whom the requisition preferences are applicable.
    • FindSSPPreferenceByPersonAndBusinessUnit: Finds the requisition preference of the preference type Self Service Procurement for the person and requisitioning BU as specified by finder parameter values.
      Finder Variables:
      • PersonId; integer; Value that uniquely identifies the user for whom the requisition preferences are applicable.
      • RequisitioningBUId; integer; Value that uniquely identifies the requisitioning BU for which the preferences are applicable.
      • SysEffectiveDate; string.
    • PrimaryKey: Finds requisition preferences according to the specified primary key criteria.
      Finder Variables:
      • UserPreferenceId; integer; Value that uniquely identifies the user's requisition preferences.
  • 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:
    • ActivePreferenceFlag; boolean; Contains one of the following values: true or false. If true, then the requisition preferences are active for the user. If false, then the preferences are not active. This attribute doesn't have a default value.
    • DestinationType; string; Type of destination to determine how the purchased goods or services should be charged. Valid values include Inventory, Expense, and Work Order.
    • PersonId; integer; Value that uniquely identifies the user for whom the requisition preferences are applicable.
    • PreferenceType; string; Type of preference to determine in which flow the requisition preferences are applicable for the user. Valid values include SSP and WORK_ORDER.
    • UserPreferenceId; integer; Value that uniquely identifies the user's requisition preferences.
  • 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
  • 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.
  • 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 : requisitionPreferences
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : requisitionPreferences-item-response
Type: object
Show Source
Nested Schema : Favorite Charge Accounts
Type: array
Title: Favorite Charge Accounts
The Favorite Charge Accounts resource gets the user's favorite charge accounts specified in the requisition preferences.
Show Source
Nested Schema : Project Costing Flexfields for Requisition Preferences
Type: array
Title: Project Costing Flexfields for Requisition Preferences
The Project Costing Flexfields resource gets the projects details for the user's requisition preferences.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AP_Distribution_Sets":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFAP__5FDistribution__5FSetsVO-item-response", "AP_Invoice_Distribution":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFAP__5FInvoice__5FDistributionVO-item-response", "AP_Invoice_Line":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFAP__5FInvoice__5FLineVO-item-response", "EXM_Expense_Report":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFEXM__5FExpense__5FReportVO-item-response", "EXM_Expense_Report_Line":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFEXM__5FExpense__5FReport__5FLineVO-item-response", "INV_Misc_Transactions":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFINV__5FMisc__5FTransactionsVO-item-response", "OM_Sales_Order":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFOM__5FSales__5FOrderVO-item-response", "PJC_All":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPJC__5FAllVO-item-response", "PJC_Expenditure_Batch":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPJC__5FExpenditure__5FBatchVO-item-response", "POR_Requisition":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPOR__5FRequisitionVO-item-response", "POR_User_Preferences":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPOR__5FUser__5FPreferencesVO-item-response", "PO_Purchase_Order":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPO__5FPurchase__5FOrderVO-item-response", "PO_Purchase_Order_Line":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPO__5FPurchase__5FOrder__5FLineVO-item-response", "PO_Purchase_Order_Schedule":"#/components/schemas/oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response" } }
Nested Schema : Purchasing News
Type: array
Title: Purchasing News
The Purchasing News resource gets the purchasing news for the user's selected requisitioning BU in the requisition preferences.
Show Source
Nested Schema : Requisitioning Options
Type: array
Title: Requisitioning Options
The Requisitioning Options resource gets the configurations of the requisitioning business unit, profile options, and status of the feature opt-ins configured for Oracle Self Service Procurement Cloud.
Show Source
Nested Schema : requisitionPreferences-favoriteChargeAccounts-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFAP__5FDistribution__5FSetsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFAP__5FInvoice__5FDistributionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFAP__5FInvoice__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFEXM__5FExpense__5FReportVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFEXM__5FExpense__5FReport__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFINV__5FMisc__5FTransactionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFOM__5FSales__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPJC__5FAllVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPJC__5FExpenditure__5FBatchVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPOR__5FRequisitionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPOR__5FUser__5FPreferencesVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPO__5FPurchase__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPO__5FPurchase__5FOrder__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_prc_por_manageReq_restModel_pjcReqPreferences_view_ReqPreferencePjcDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionPreferences-purchasingNews-item-response
Type: object
Show Source
Nested Schema : requisitionPreferences-requisitioningOptions-item-response
Type: object
Show Source
  • Contains one of the following values: true or false. If true, then allow one-time address to be used in the add requisition line flow. If false, then don't allow one-time address. The default value is false.
  • Read Only: true
    Contains one of the following values: true or false. If true, then the Agreement Description Override on Requisition Lines Allowed (ORA_POR_BPA_DESCRIPTION_OVERRIDE) profile value is set to Yes. If false, then the Agreement Description Override on Requisition Lines Allowed (ORA_POR_BPA_DESCRIPTION_OVERRIDE) profile value is set to No. This attribute doesn't have a default value.
  • Contains one of the following values: true or false. If true, then customer uses the information templates. If false, then the customer doesn't use information template. This attribute doesn't have a default value.
  • Read Only: true
    Value that uniquely identifies the chart of account associated with the requisitioning business unit.
  • Title: Conversion Rate Type
    Read Only: true
    Default rate type of the requisitioning business unit used to determine the currency conversion rate.
  • Contains one of the following values: true or false. If true, then the Display Product Packaging String feature is enabled. If false, then the Display Product Packaging String feature is disabled. This attribute doesn't have a default value.
  • Read Only: true
    Maximum Length: 80
    Distribution descriptive flexfield context set in the configure requisitioning business function.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the overriding approver option is enabled while creating or modifying requisitions. If false, then the overriding approver option isn???t enabled. This attribute doesn't have a default value.
  • Read Only: true
    Contains one of the following values: true or false. If true, then the feature to procure extended contract item is enabled. If false, then the feature to procure extended contract item is disabled. This attribute doesn't have a default value.
  • Contains one of the following values: true or false. If true, then the feature Fulfill Expense Requisitions for Agreement-Based Catalog Items from Internal Sources is enabled. If false, then the feature Fulfill Expense Requisitions for Agreement-Based Catalog Items from Internal Sources is disabled. This attribute doesn't have a default value.
  • Title: Functional Currency
    Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the currency of the primary ledger of the requisitioning business unit in the user's preferences.
  • Read Only: true
    Maximum Length: 80
    Header descriptive flexfield context set in the configure requisitioning business function.
  • Contains one of the following values: true or false. If true, then the feature Internal Material Transfers is enabled. If false, then the feature Internal Material Transfers is disabled. This attribute doesn't have a default value.
  • System date in the time zone of the inventory organization associated with the requisitioning business unit in the user's requisition preferences.
  • Contains one of the following values: true or false. If true, then the feature, View and Resolve Payment Holds for Requested Items, is enabled. If false, then the feature, View and Resolve Payment Holds for Requested Items, is disabled. This attribute doesn't have a default value.
  • Title: Legal Entity Date
    System date in the time zone of the legal entity associated with requisitioning business unit in the user's requisition preferences.
  • Read Only: true
    Maximum Length: 80
    Line descriptive flexfield context set in the configure requisitioning business function.
  • Read Only: true
    Value that uniquely identifies the line type used for defaulting the item type in the add requisition line flow.
  • Links
  • Read Only: true
    Contains one of the following values: true or false. If true, then the feature to shop for items from Oracle Healthcare Marketplace is enabled. If false, then the feature to shop for items from Oracle Healthcare Marketplace is disabled. This attribute's default value is false.
  • Title: Packaging String Order
    Display order of the packaging string units configured in the application.
  • Read Only: true
    Contains one of the following values: true or false. If true, then the Account Updates Allowed on Project-Related Distributions (PJC_ALLOW_ACCOUNT_OVERRIDE) profile value is set to Yes. If false, then the Account Updates Allowed on Project-Related Distributions (PJC_ALLOW_ACCOUNT_OVERRIDE) profile value is set to No. This attribute doesn't have a default value.
  • Contains one of the following values: true or false. If true, then the Responsive Self Service Procurement Application is enabled. If false, then the Responsive Self Service Procurement Application isn't enabled. This attribute doesn't have a default value.
  • Read Only: true
    Contains one of the following values: true or false. When the Project Costing feature is enabled in the application, the attribute is set to true, if not, it is set to false. This attribute doesn't have a default value.
  • Contains one of the following values: true or false. If true, then the feature Accept Supply Chain Requested Dates in Local Time Zone is enabled. If false, then the feature Accept Supply Chain Requested Dates in Local Time Zone is disabled. This attribute doesn't have a default value.
  • Title: Requested Delivery Date Offset
    Requested delivery date offset value configured in the application.
  • Read Only: true
    Value that uniquely identifies the requisitioning business unit.
  • Read Only: true
    Value that uniquely identifies the configuration of the requisitioning function for requisitioning business unit.
  • Read Only: true
    Contains one of the following values: true or false. If true, then the feature Procure Goods from Preferred Sources During Catalog Shopping is enabled. If false, then the feature Procure Goods from Preferred Sources During Catalog Shopping is disabled. This attribute's default value is false.
  • Read Only: true
    Contains one of the following values: Y or N. If Y, the additional item attributes are displayed in the responsive web application. If N, then the attributes are not displayed. This attribute's default value is N.
  • Read Only: true
    Contains one of the following values: true or false. If true, the descriptive flex fields are displayed in Progressive Web Application. If false, then descriptive flex fields are not displayed. This attribute's default value is true.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, available quantity is shown for the internal supply source. If false, then available quantity is shown for the internal supply source. This attribute's default value is false.
  • Contains one of the following values: true or false. When the Special Handling feature is enabled in the application, the attribute is set to true, if not, it's set to false. This attribute doesn't have a default value.
Back to Top

Examples

This example describes how to get all preferences.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/requisitionPreferences"

Example Response Body

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

{
	"items": [
	{
		"UserPreferenceId": 100010026864167,
		"RequisitioningBUId": 204,
		"RequisitioningBU": "Vision Operations",
		"PersonId": 100010026864167,
		"UserDisplayName": "Ericka Jones",
		"UserEmail": "Jones-B@example.com",
		"RequesterId": 100010026864167,
		"Requester": "Ericka Jones",
		"RequesterEmail": "Jones-B@example.com",
		"DeliverToLocationId": 204,
		"DeliverToLocationCode": "V1-_NEW_YORK_CITY_0_2450399170046",
		"DeliverToLocationName": "V1- New York City",
		"DestinationOrganizationId": 204,
		"DestinationOrganization": "Vision Operations",
		"DestinationOrganizationCode": "V1",
		"DestinationTypeCode": "EXPENSE",
		"DestinationType": "Expense",
		"DestinationSubinventory": null,
		"WorkOrderId": null,
		"WorkOrder": null,
		"WorkOrderOperationId": null,
		"WorkOrderOperationSequence": null,
		"PreferenceType": "SSP",
		"ActivePreferenceFlag": true,
		"WorkOrderInventoryOrganizationId": null,
		"WorkOrderInventoryOrganizationCode": null,
		"WorkOrderInventoryOrganization": null,
		"CreatedBy": "0",
		"CreationDate": "2009-08-19T23:13:41+00:00",
		"LastUpdatedBy": "CVRQST07",
		"LastUpdateDate": "2020-08-11T06:38:32.179+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/requisitionPreferences/100010026864167",
			"name": "requisitionPreferences",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/requisitionPreferences/100010026864167",
			"name": "requisitionPreferences",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/requisitionPreferences/100010026864167/child/projectDFF",
			"name": "projectDFF",
			"kind": "collection"
		}
		]
	},
	{
		...
	}
	],
	"count": 5,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/requisitionPreferences",
		"name": "requisitionPreferences",
		"kind": "collection"
	}
	]
}
Back to Top