Create one parameter

post

/fscmRestApi/resources/11.13.18.05/initializationParameters

Request

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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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.
  • Header attributes of the quote, order, or cart. The header 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.
  • 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: allow validation to modify the configuration to make it valid. False: do not allow the modification. The default value is True.
  • Contains one of the following values. True: if a validation error occurs, then stop validation and return control to the application that called validation. False, do not stop validation. The default value is True.
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 : initializationParameters-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: the initialization parameters that this configuration session uses have expired. False: they have not expired. The default value is False. This attribute is read-only.
  • Header attributes of the quote, order, or cart. The header 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: allow validation to modify the configuration to make it valid. False: do not allow the modification. The default value is True.
  • Contains one of the following values. True: if a validation error occurs, then stop validation and return control to the application that called validation. False, do not stop validation. The default value is True.
Back to Top

Examples

This example describes how to create one initialization parameter.

Example cURL Command

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

curl -u username:password -X POST -H "servername/fscmRestApi/resources/version/initializationParameters"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

"{ 
  "CallingApplicationCode":"ORA_BM_CPQ",
  "Line":"{\"UnitQuantity\":1,\"InventoryItemNumber\":\"zCZ-AS100\",\"RequestOn\":\"2016-06-06T12:30:31-0700\",\"InventoryOrganizationCode\":\"V1\",\"UomCode\":\"Ea\",\"LineId\":-2147483648}"
}"

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
  "ParameterId" : 300100096169089,
  "CallingApplicationCode" : "ORA_BM_CPQ",
  "Header" : null,
  "Line" : "{\"UnitQuantity\":1,\"InventoryItemNumber\":\"zCZ-AS100\",\"RequestOn\":\"2016-06-06T12:30:31-0700\",\"InventoryOrganizationCode\":\"V1\",\"UomCode\":\"Ea\",\"LineId\":-2147483648,\"InventoryOrganizationId\":204,\"InventoryItemId\":300100016171847}",
  "CustomParameters" : null,
  "ManualPriceAdjustments" : null,
  "PageTitlePrefix" : null,
  "ExpiredFlag" : false,
  "ErrorMessageText" : null,
  "TerminalActionCaption" : null, 
  ...
}"
Back to Top