Jump to

• Request
• Response
• Examples

Get Related Configurators

post

/rest/v19/bomItemSetups/{bomItemVarName}/actions/getRelatedConfigurators

Use this endpoint to retrieve all product hierarchies having BOM Mapping rules mapped to the root BOM item.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Root Schema : BOM Item Setup Get Related Configurators Request Definitions

Type: object

Title: BOM Item Setup Get Related Configurators Request Definitions

Show Source

• limit: integer
  Title: Limit

  Maximum number of getRelatedConfigurators items returned.
• offset: integer
  Title: Offset

  Specifies the index of the first item to be returned

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"Specifies the index of the first item to be returned",
            "title":"Offset"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of getRelatedConfigurators items returned.",
            "title":"Limit"
        }
    },
    "title":"BOM Item Setup Get Related Configurators Request Definitions"
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : BOM Item Setup Get Related Configurators Response Definitions

Type: object

Title: BOM Item Setup Get Related Configurators Response Definitions

Show Source

• relatedConfigurators: object Related Configurator Product Hierarchy Items
  Title: Related Configurator Product Hierarchy Items

  List of Product Hierarchy items having BOM mapping rules mapped to the Root BOM Item

{
    "type":"object",
    "properties":{
        "relatedConfigurators":{
            "$ref":"#/definitions/bomItemSetupsGetRelatedConfiguratorItemsModel"
        }
    },
    "title":"BOM Item Setup Get Related Configurators Response Definitions"
}

Nested Schema : Related Configurator Product Hierarchy Items

Type: object

Title: Related Configurator Product Hierarchy Items

List of Product Hierarchy items having BOM mapping rules mapped to the Root BOM Item

Show Source

• count: integer
  Title: Count

  Integer value for pagination count
• hasMore: boolean
  Title: Has More

  Boolean value for whether more paginated results exist
• items: array items
• limit: integer
  Title: Limit

  Integer value for pagination limit
• offset: integer
  Title: Offset

  Integer value for pagination offset
• totalResults: integer
  Title: Total Results

  Integer value for number of total results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/bomItemSetupsGetRelatedConfiguratorModel"
            }
        },
        "offset":{
            "type":"integer",
            "description":"Integer value for pagination offset",
            "title":"Offset"
        },
        "limit":{
            "type":"integer",
            "description":"Integer value for pagination limit",
            "title":"Limit"
        },
        "count":{
            "type":"integer",
            "description":"Integer value for pagination count",
            "title":"Count"
        },
        "totalResults":{
            "type":"integer",
            "description":"Integer value for number of total results",
            "title":"Total Results"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value for whether more paginated results exist",
            "title":"Has More"
        }
    },
    "title":"Related Configurator Product Hierarchy Items",
    "description":"List of Product Hierarchy items having BOM mapping rules mapped to the Root BOM Item"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Related Configurator Product Hierarchies
  Title: Related Configurator Product Hierarchies

  Product Hierarchy model having BOM mapping rules mapped to the Root BOM Item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/bomItemSetupsGetRelatedConfiguratorModel"
    }
}

Nested Schema : Related Configurator Product Hierarchies

Type: object

Title: Related Configurator Product Hierarchies

Product Hierarchy model having BOM mapping rules mapped to the Root BOM Item.

Show Source

• dateAdded: string(date)
  Title: DateAdded

  Config Auto Generator Task creation date
• effectiveFrom: string(date)
  Title: Effective From

  Model BOM mapping rule effective from date
• effectiveTo: string(date)
  Title: Effective To

  Model BOM mapping rule effective to date
• id: integer
  Title: Id

  Config Auto Generator Task Id incase of failure otherwise Bom Mapping Rule Id incase of success
• model: string
  Title: Model

  Name of the Model
• productFamily: string
  Title: Product Family

  Name of the Product Family
• productLine: string
  Title: Product Line

  Name of the Product Line
• progressPercentage: integer
  Title: Progress Percentage

  Config Auto Generator Task Progress Percentage
• status: string
  Title: Status

  Status of the Configurator
• statusMessage: string
  Title: Status Message

  Config Auto Generator Task status message

{
    "type":"object",
    "properties":{
        "productFamily":{
            "type":"string",
            "description":"Name of the Product Family",
            "title":"Product Family"
        },
        "productLine":{
            "type":"string",
            "description":"Name of the Product Line",
            "title":"Product Line"
        },
        "model":{
            "type":"string",
            "description":"Name of the Model",
            "title":"Model"
        },
        "status":{
            "type":"string",
            "description":"Status of the Configurator",
            "title":"Status"
        },
        "dateAdded":{
            "type":"string",
            "format":"date",
            "description":"Config Auto Generator Task creation date",
            "title":"DateAdded"
        },
        "progressPercentage":{
            "type":"integer",
            "description":"Config Auto Generator Task Progress Percentage",
            "title":"Progress Percentage"
        },
        "statusMessage":{
            "type":"string",
            "description":"Config Auto Generator Task status message",
            "title":"Status Message"
        },
        "id":{
            "type":"integer",
            "description":"Config Auto Generator Task Id incase of failure otherwise Bom Mapping Rule Id incase of success",
            "title":"Id"
        },
        "effectiveFrom":{
            "type":"string",
            "format":"date",
            "description":"Model BOM mapping rule effective from date",
            "title":"Effective From"
        },
        "effectiveTo":{
            "type":"string",
            "format":"date",
            "description":"Model BOM mapping rule effective to date",
            "title":"Effective To"
        }
    },
    "title":"Related Configurator Product Hierarchies",
    "description":"Product Hierarchy model having BOM mapping rules mapped to the Root BOM Item."
}

Back to Top

Examples

The following example shows how to retrieve all product hierarchies having BOM Mapping rules mapped to the root BOM item by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/bomItemSetups/someModel/actions/getRelatedConfigurators

Response Body Sample

{
  "hasMore": false,
  "relatedConfigurators": {
    "items": [{
        "productFamily": "Generator 2",
        "productLine": "Single 2",
        "model": "Model Single 2",
        "status": "In Progress",
        "companyId": 4118171,
        "statusMessage": "This configuration is in progress.",
        "progressPercentage": 75
      }, {
        "productFamily": "Generator 2",
        "productLine": "Single 2",
        "model": "Model Single 2",
        "status": "Failed",
        "companyId": 4118171,
        "dateAdded": 1711338972000,
        "statusMessage": "The auto generation failed and changes have been reverted. Please try again.",
        "progressPercentage": 0
      }
    ],
    "offset": 0,
    "limit": 5,
    "count": 1,
    "totalResults": 1,
    "hasMore": false
  }
}

Back to Top