Jump to

• Request
• Response
• Examples

Create one parameter

post

/fscmRestApi/resources/11.13.18.05/initializationParameters

Request

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CallingApplicationCode: string
  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.
• CurrencyCode: string
  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.
• CustomParameters: string
  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.
• ErrorMessageText: string
  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: string
  Header attributes of the quote, order, or cart. The header includes identifying details, such as the customer name and ship-to location.
• Line: string
  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.
• ManualPriceAdjustments: string
  Price adjustments to apply during configuration.
• PageTitlePrefix: string
  Text to add as a prefix to the page subtitle during the configurator session.
• ParameterId: integer
  Value that uniquely identifies the initialization parameters for the configuration.
• TerminalActionCaption: string
  Text to display, such as Finish or OK, as the caption for a final action in the configurator session.
• ValidationCannotAlterFlag: boolean
  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.
• ValidationFailFastFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "ValidationCannotAlterFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ValidationFailFastFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CallingApplicationCode":{
            "maxLength":1000,
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "ParameterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the initialization parameters for the configuration.",
            "nullable":false
        },
        "Line":{
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Header":{
            "type":"string",
            "description":"Header attributes of the quote, order, or cart. The header includes identifying details, such as the customer name and ship-to location.",
            "nullable":true,
            "x-queryable":false
        },
        "TerminalActionCaption":{
            "type":"string",
            "description":"Text to display, such as Finish or OK, as the caption for a final action in the configurator session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AdditionalParameters"
                ]
            }
        },
        "ErrorMessageText":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualPriceAdjustments":{
            "type":"string",
            "description":"Price adjustments to apply during configuration.",
            "nullable":true,
            "x-queryable":false
        },
        "PageTitlePrefix":{
            "type":"string",
            "description":"Text to add as a prefix to the page subtitle during the configurator session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AdditionalParameters"
                ]
            }
        },
        "CustomParameters":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : initializationParameters-item-response

Type: object

Show Source

• CallingApplicationCode: string
  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.
• CurrencyCode: string
  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.
• CustomParameters: string
  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.
• ErrorMessageText: string
  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.
• ExpiredFlag: boolean
  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: string
  Header attributes of the quote, order, or cart. The header includes identifying details, such as the customer name and ship-to location.
• Line: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualPriceAdjustments: string
  Price adjustments to apply during configuration.
• PageTitlePrefix: string
  Text to add as a prefix to the page subtitle during the configurator session.
• ParameterId: integer
  Value that uniquely identifies the initialization parameters for the configuration.
• TerminalActionCaption: string
  Text to display, such as Finish or OK, as the caption for a final action in the configurator session.
• ValidationCannotAlterFlag: boolean
  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.
• ValidationFailFastFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "ValidationCannotAlterFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ValidationFailFastFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CallingApplicationCode":{
            "maxLength":1000,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ParameterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the initialization parameters for the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "Line":{
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Header":{
            "type":"string",
            "description":"Header attributes of the quote, order, or cart. The header includes identifying details, such as the customer name and ship-to location.",
            "nullable":true,
            "x-queryable":false
        },
        "TerminalActionCaption":{
            "type":"string",
            "description":"Text to display, such as Finish or OK, as the caption for a final action in the configurator session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AdditionalParameters"
                ]
            }
        },
        "ErrorMessageText":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualPriceAdjustments":{
            "type":"string",
            "description":"Price adjustments to apply during configuration.",
            "nullable":true,
            "x-queryable":false
        },
        "PageTitlePrefix":{
            "type":"string",
            "description":"Text to add as a prefix to the page subtitle during the configurator session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AdditionalParameters"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomParameters":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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