Jump to

• Request
• Response
• Examples

Generate Configurator

post

/rest/v16/bomItemSetups/{bomItemVarName}/actions/generateConfigurator

Use this endpoint to create a simple configurator based on the BOM hierarchy setup. The auto-generator will create and deploy: a BOM mapping rule, configurable attributes corresponding to BOM items, and a configuration flow layout.

Request

Supported Media Types

• application/json

Path Parameters

• bomItemVarName(required): string
  Variable Name of the BOM item

Body ()

Root Schema : bomItemSetups-generateConfiguratorRequest

Type: object

Show Source

• defaultEffectiveFrom: string
  Title: Default Effective from Date

  Default Effective from Date for BOM item Configuration.
• defaultEffectiveTo: string
  Title: Default Effective to Date

  Default Effective to Date for BOM item Configuration.
• description: string
  Title: Description

  Description for BOM item Configuration.
• modelLabel: string
  Title: Model Name

  Model name for BOM item Configuration.
• modelVariableName: string
  Title: Model Variable Name

  Model variable name for BOM item Configuration.
• productFamilyLabel: string
  Title: Product Family Name

  Product Family name for BOM item Configuration.
• productFamilyVariableName: string
  Title: Product Family Variable Name

  Product Family variable name for BOM item Configuration.
• productLineLabel: string
  Title: Product Line Name

  Product Line name for BOM item Configuration.
• productLineVariableName: string
  Title: Product Line Variable Name

  Product Line variable name for BOM item Configuration.

{
    "type":"object",
    "properties":{
        "defaultEffectiveTo":{
            "type":"string",
            "description":"Default Effective to Date for BOM item Configuration.",
            "title":"Default Effective to Date"
        },
        "defaultEffectiveFrom":{
            "type":"string",
            "description":"Default Effective from Date for BOM item Configuration.",
            "title":"Default Effective from Date"
        },
        "productFamilyLabel":{
            "type":"string",
            "description":"Product Family name for BOM item Configuration.",
            "title":"Product Family Name"
        },
        "productFamilyVariableName":{
            "type":"string",
            "description":"Product Family variable name for BOM item Configuration.",
            "title":"Product Family Variable Name"
        },
        "description":{
            "type":"string",
            "description":"Description for BOM item Configuration.",
            "title":"Description"
        },
        "productLineLabel":{
            "type":"string",
            "description":"Product Line name for BOM item Configuration.",
            "title":"Product Line Name"
        },
        "productLineVariableName":{
            "type":"string",
            "description":"Product Line variable name for BOM item Configuration.",
            "title":"Product Line Variable Name"
        },
        "modelVariableName":{
            "type":"string",
            "description":"Model variable name for BOM item Configuration.",
            "title":"Model Variable Name"
        },
        "modelLabel":{
            "type":"string",
            "description":"Model name for BOM item Configuration.",
            "title":"Model Name"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : bomItemSetups-generateConfiguratorResponse

Type: object

Back to Top

Examples

The following example shows how to create a simple configurator based on the BOM hierarchy setup by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/bomItemSetups/someModel/actions/generateConfigurator

Request Body Sample

{
  "productFamilyVariableName": "someProductFamily",
  "productFamilyLabel": "Some Product Family",
  "productLineVariableName": "someProductLine",
  "productLineLabel": "Some Product Line",
  "modelVariableName": "someModel",
  "modelLabel": "Some Model",
  "description": "A slightly longer paragraph with some text.",
  "defaultEffectiveFrom": "2023-10-30 00:00:00Z",
  "defaultEffectiveTo": "2024-10-30 12:00:00Z"
}

Response Body Sample

{
  "items": []
}

Back to Top