1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Configuration Initialization Parameters

Get all parameters

get

/fscmRestApi/resources/11.13.18.05/configurationInitializationParameters

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:

    • PrimaryKey: Find a configuration initialization parameter according to parameter Id.
      Finder Variables:
      • ParameterId; integer; Identifies the configuration initialization parameter.
  • 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:
    • CallingApplicationCode; string; Abbreviation that identifies the name of the application that called this resource. This resource uses this name to identify the user interface to call when starting an interactive session.
    • CurrencyCode; string; Abbreviation that identifies the currency to be used at runtime when pricing the items in the configuration. No value implies base currency will be used to price items.
    • ExpiredFlag; boolean; Contains one of the following values: true or false. If true, then the initialization parameters that this configuration session uses have expired. If false, then they have not expired. The default value is false. This attribute is read-only.
    • ParameterId; integer; Value that uniquely identifies the initialization parameters for the configuration.
  • 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 : configurationInitializationParameters
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : configurationInitializationParameters-item-response
Type: object
Show Source
  • Maximum Length: 1000
    Abbreviation that identifies the name of the application that called this resource. This resource uses this name to identify the user interface to call when starting an interactive session.
  • Maximum Length: 15
    Abbreviation that identifies the currency to be used at runtime when pricing the items in the configuration. No value implies base currency will be used to price items.
  • Extensible parameter to use during the configuration session. Each extensible parameter includes a name and value. It includes details that you can specify during configuration to extend the inventory item that you are configuring.
  • Error message text for a configuration runtime session that fail to start. You can use the ParameterId attribute to get the attribute that this configuration session uses.
  • Read Only: true
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the initialization parameters that this configuration session uses have expired. If false, then they have not expired. The default value is false. This attribute is read-only.
  • Value that indicates header attributes for a quote, an order, or a cart. This attribute includes identifying details, such as the customer name and ship-to location.
  • Line to configure for the quote, order, or cart. The line includes identifying details, such as the inventory item number, organization code, and the effective date to use when starting a configuration session.
  • Links
  • Price adjustments to apply during configuration.
  • Text to add as a prefix to the page subtitle during the configurator session.
  • Value that uniquely identifies the initialization parameters for the configuration.
  • Text to display, such as Finish or OK, as the caption for a final action in the configurator session.
  • Contains one of the following values: true or false. If true, then allow validation to modify the configuration to make it valid. If false, then do not allow the modification. The default value is true.
  • Contains one of the following values: true or false. If true, and if a validation error occurs, then stop validation and return control to the application that called validation. If false, then do not stop validation. The default value is true.
Back to Top

Examples

This example describes how to get all parameters.

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/configurationInitializationParameters"

Example Response Body

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

{
  "items" : [ {
    "ParameterId" : 300100089730550,
    "CallingApplicationCode" : "ORA_BM_CPQ",
    "Header" : null,
    "Line" : "{\"InventoryItemNumber\":\"zCZ-AS100\",\"InventoryOrganizationId\":204,\"InventoryItemId\":300100016171847,\"InventoryOrganizationCode\":\"V1\"}",
    "CustomParameters" : null,
    "ManualPriceAdjustments" : null,
    "PageTitlePrefix" : null,
    "ExpiredFlag" : false,
    "ErrorMessageText" : null,
    "TerminalActionCaption" : null,
    "links" : [ {   
        ....
    }, {
     ...
    } ]
  }, {
    "ParameterId" : 300100089730551,
    "CallingApplicationCode" : "ORA_BM_CPQ",
    "Header" : null,
    "Line" : "{\"InventoryItemNumber\":\"zCZ-AS100\",\"InventoryOrganizationId\":204,\"InventoryItemId\":300100016171847,\"InventoryOrganizationCode\":\"V1\"}",
    "CustomParameters" : null,
    "ManualPriceAdjustments" : null,
    "PageTitlePrefix" : null,
    "ExpiredFlag" : true,
    "ErrorMessageText" : null,
    "TerminalActionCaption" : null,
    "links" : [ {
       ....
    }, {  
      ...
    } ]
  }, 
   ...
  } ]
Back to Top