Get all requisitioning options
get
/fscmRestApi/resources/11.13.18.05/requisitionPreferences/{requisitionPreferencesUniqID}/child/requisitioningOptions
Request
Path Parameters
-
requisitionPreferencesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Requisition Preferences resource and used to uniquely identify an instance of Requisition Preferences. The client should not generate the hash key value. Instead, the client should query on the Requisition Preferences collection resource in order to navigate to a specific instance of Requisition Preferences to get the hash key.
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 requisitioning options from the requisition preferences according to the specified primary key criteria.
Finder Variables:- RequisitioningBUOptionsId; integer; Value that uniquely identifies the configuration of the requisitioning function for the requisitioning business unit.
- PrimaryKey: Finds requisitioning options from the requisition preferences according to the specified primary key criteria.
-
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:- AllowOnetimeAddrFlag; boolean; 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.
- CatalogInformationTemplateApplicableFlag; boolean; 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.
- ChartOfAccountId; integer; Value that uniquely identifies the chart of account associated with the requisitioning business unit.
- DisplayPackagingStringOptinFlag; boolean; 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.
- EnableApproverOverrideFlag; boolean; 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.
- ExpenseAgreementLinesFromInternalSourcesOptinFlag; boolean; 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.
- FunctionalCurrencyCode; string; Abbreviation that identifies the currency of the primary ledger of the requisitioning business unit in the user's preferences.
- HeaderDffContextCode; string; Header descriptive flexfield context set in the configure requisitioning business function.
- InternalMaterialTransfersOptinFlag; boolean; 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.
- InventoryOrganizationSystemDate; string; System date in the time zone of the inventory organization associated with the requisitioning business unit in the user's requisition preferences.
- InvoiceHoldOptinFlag; boolean; 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.
- LESystemDate; string; System date in the time zone of the legal entity associated with requisitioning business unit in the user's requisition preferences.
- LineDffContextCode; string; Line descriptive flexfield context set in the configure requisitioning business function.
- LineTypeId; integer; Value that uniquely identifies the line type used for defaulting the item type in the add requisition line flow.
- PackagingStringOrder; string; Display order of the packaging string units configured in the application.
- ProgressiveWebappOptinFlag; boolean; Contains one of the following values: true or false. If true, then the Procure Goods and Services Using a Progressive Web Application feature is enabled. If false, then Procure Goods and Services Using a Progressive Web Application feature is disabled. This attribute doesn't have a default value.
- RequestedDateInLocalTimeOptinFlag; boolean; 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.
- RequestedDeliveryDateOffset; string; Requested delivery date offset value configured in the application.
- RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit.
- RequisitioningBUOptionsId; integer; Value that uniquely identifies the configuration of the requisitioning function for requisitioning business unit.
-
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 : requisitionPreferences-requisitioningOptions
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 : requisitionPreferences-requisitioningOptions-item-response
Type:
Show Source
object
-
AllowOnetimeAddrFlag: boolean
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.
-
CatalogInformationTemplateApplicableFlag: boolean
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.
-
ChartOfAccountId: integer
Read Only:
true
Value that uniquely identifies the chart of account associated with the requisitioning business unit. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Default rate type of the requisitioning business unit used to determine the currency conversion rate. -
DisplayPackagingStringOptinFlag: boolean
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.
-
EnableApproverOverrideFlag: boolean
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. -
ExpenseAgreementLinesFromInternalSourcesOptinFlag: boolean
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.
-
FunctionalCurrencyCode: string
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. -
HeaderDffContextCode: string
Read Only:
true
Maximum Length:80
Header descriptive flexfield context set in the configure requisitioning business function. -
InternalMaterialTransfersOptinFlag: boolean
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.
-
InventoryOrganizationSystemDate: string
(date)
System date in the time zone of the inventory organization associated with the requisitioning business unit in the user's requisition preferences.
-
InvoiceHoldOptinFlag: boolean
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.
-
LESystemDate: string
(date)
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. -
LineDffContextCode: string
Read Only:
true
Maximum Length:80
Line descriptive flexfield context set in the configure requisitioning business function. -
LineTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the line type used for defaulting the item type in the add requisition line flow. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PackagingStringOrder: string
Title:
Packaging String Order
Display order of the packaging string units configured in the application. -
PJCAllowAccountOverride: string
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. -
ProgressiveWebappOptinFlag: boolean
Contains one of the following values: true or false. If true, then the Procure Goods and Services Using a Progressive Web Application feature is enabled. If false, then Procure Goods and Services Using a Progressive Web Application feature is disabled. This attribute doesn't have a default value.
-
ProjectCostingFeatureOptinFlag: boolean
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. -
RequestedDateInLocalTimeOptinFlag: boolean
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.
-
RequestedDeliveryDateOffset: string
Title:
Requested Delivery Date Offset
Requested delivery date offset value configured in the application. -
RequisitioningBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisitioning business unit. -
RequisitioningBUOptionsId: integer
(int64)
Read Only:
true
Value that uniquely identifies the configuration of the requisitioning function for requisitioning business unit. -
ShowAdditionalItemAttributes: string
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. -
ShowDFFByDefault: string
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.
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
This example describes how to get all requisitioning options.
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/requisitionPreferencesUniqID/child/requisitioningOptions"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "RequisitioningBUOptionsId": 100010024519191, "RequisitioningBUId": 204, "LineTypeId": 1, "HeaderDffContextCode": null, "LineDffContextCode": "ABP Special Project Info", "FunctionalCurrencyCode": "USD", "LESystemDate": "2022-06-14", "InventoryOrganizationSystemDate": "2022-06-14", "PackagingStringOrder": "ORA_RCS_PS_ASC", "DisplayPackagingStringOptinFlag": "false", "RequestedDeliveryDateOffset": "7", "ProgressiveWebappOptinFlag": "true", "AllowOnetimeAddrFlag": true, "ChartOfAccountId": 101, "ProjectCostingFeatureOptinFlag": "true", "PJCAllowAccountOverride": "Y", "ShowDFFByDefault": "N", "RequestedDateInLocalTimeOptinFlag": "false", "InvoiceHoldOptinFlag": "true", "ConversionRateType": "Corporate", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551/child/requisitioningOptions/100010024519191", "name": "requisitioningOptions", "kind": "item" }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551/child/requisitioningOptions/100010024519191", "name": "requisitioningOptions", "kind": "item" }, { "rel": "parent", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551", "name": "requisitionPreferences", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/requisitionPreferences/300100046918551/child/requisitioningOptions", "name": "requisitioningOptions", "kind": "collection" } ] }