Jump to

• Request
• Response
• Examples

Get one component

get

/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}

Request

Path Parameters

• BillSequenceId(required): integer
  Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
• ComponentSequenceId(required): number
  Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : itemStructures-Component-item-response

Type: object

Show Source

• AbsoluteYield: number
  Title: Absolute Yield

  Read Only: true

  Represents the absolute yield of a component. This value equals to quantity times yield.
• AcdType: integer
  Title: Change Action

  Read Only: true

  Default Value: 1

  Identifies whether the component is being added, modified, or deleted in a change line.
• ACDTypeValue: string
  Read Only: true

  Maximum Length: 255

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• AutoRequestMaterialFlag: boolean
  Title: Automatically Request Material

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true.
• BasisType: integer
  Title: Basis

  Default Value: 1

  Value that indicates if the option class quantity can be overridden by sales order. Valid values include None (can override) or Option Class (cannot override).
• BasisValue: string
  Value that determines if the option class quantity can be overridden by the sales order. Valid values include None or Option Class.
• BillSequenceId: integer
  Value that uniquely identifies the structure.
• ChangeId: integer
  Identifies the change order to which the pending component has been added.
• ChangeLineId: integer
  Read Only: true

  Default Value: -1

  Value that uniquely identifies the revised change line to which pending component is added.
• ChangeNotice: string
  Read Only: true

  Maximum Length: 255

  Change order notice to which the pending component is added.
• CheckATPFlag: boolean
  Title: Check ATP

  Default Value: false

  Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Comments about a component.
• CompAlternateBomDesignator: string
  Title: Formula Name

  Maximum Length: 80

  Indicates the context formula for an ingredient.
• CompletionType: string
  Title: Completion Type

  Maximum Length: 30

  Indicates how the output item will be reported during work execution.
• CompletionTypeValue: string
  Maximum Length: 255

  Value used by the manufacturer to define the completion type of products. The values are Automatic, Manual, or None.
• ComponentDFF: array Flexfields for Components
  Title: Flexfields for Components

  The Flexfields for Components resource gets the descriptive flexfields associated with the component.
• ComponentItemClass: string
  Read Only: true

  Maximum Length: 255

  Class of the component item. This attribute is read-only and is not required for an update operation.
• ComponentItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item associated with the component.
• ComponentItemNumber: string
  Number that indicates the item of a component. This attribute is read-only, which can be modified for the create operation.
• ComponentSequenceId: integer
  Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
• ComponentType: string
  Title: Material Type

  Maximum Length: 30

  Default Value: INPUT

  Indicates the type of material for the formula.
• ComponentTypeValue: string
  Maximum Length: 255

  Indicates the type of material. The values include Ingredient or Product.
• ContributeToYield: string
  Title: Contribute to Yield

  Maximum Length: 30

  Indicates whether the ingredient quantity should contribute to the yield.
• ContributeToYieldValue: string
  Maximum Length: 255

  Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the component.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was created.
• EndDateTime: string (date-time)
  Title: End Date

  Date and time when a component in a structure ends.
• EnforceIntegerRequirementsValue: string
  Value that is used by planning to generate the demand in integer quantities. Values include Round Up, Round Down, or None.
• EnforceIntRequirements: number
  Title: Enforce Integer Requirement

  Default Value: 0

  Value that is used by Oracle Supply Planning Cloud to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
• FindNumber: integer
  Title: Find Number

  Default Value: 1

  Number used to locate a specific instance of an item in a structure.
• FromNumber: string
  Title: From End Item Unit Number

  Maximum Length: 30

  Number that indicates the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
• ImplementationDateTime: string (date-time)
  Title: Effective Date

  Read Only: true

  Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components.
• IncludeOnShipDocsFlag: boolean
  Title: Include on Shipping Documents

  Default Value: false

  Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true.
• InstantiabilityCode: string
  Title: Instantiability

  Maximum Length: 30

  Abbreviation that identifies the whether a component item is instantiable in an item structure.
• InstantiabilityValue: string
  Value that indicates whether a component item is instantiable in an item structure.
• ItemSequenceNumber: number
  Title: Item Sequence

  Number that defines the sequence of components in a structure.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the component.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who most recently updated the component.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumQuantity: number
  Title: Maximum Quantity

  Value that indicates the maximum order quantity.
• MinimumQuantity: number
  Title: Minimum Quantity

  Value that indicates the minimum order quantity.
• MutuallyExclusiveFlag: boolean
  Title: Mutually Exclusive

  Default Value: false

  Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true.
• OldComponentSequenceId: integer
  Read Only: true

  Reference to the production row when the component is modified in a change line.
• OptionalFlag: boolean
  Title: Optional

  Default Value: false

  Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true.
• OrganizationId: string
  Maximum Length: 240

  Value that uniquely identifies the organization.
• PlanningPercent: number
  Title: Planning Percent

  Default Value: 100

  Distribution percentage for a component. It is used by forecast planning.
• PrimaryUOMCode: string
  Maximum Length: 30

  Primary unit of measure for the item quantities.
• PrimaryUOMCodeValue: string
  Maximum Length: 255

  Value that indicates the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each.
• PrimaryUOMValue: string
  Read Only: true

  Maximum Length: 255

  Value in the primary unit of measure for the item quantities.
• ProductType: string
  Title: Product Type

  Maximum Length: 30

  Indicates the type of product for the formula output.
• ProductTypeValue: string
  Maximum Length: 255

  Indicates the product type. The values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
• Quantity: number
  Title: Quantity

  Default Value: 1

  Quantity of component item that is used.
• QuantityRelatedFlag: boolean
  Title: Quantity Related

  Default Value: false

  Value that indicates whether a component is quantity related or not. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.
• ReferenceDesignator: array Reference Designators
  Title: Reference Designators

  The Reference Designators resource manages the details of a reference designator.
• ReplacedBy: string
  Maximum Length: 255

  Item number of the replacement component.
• ReplacedByFindNumber: integer
  New find number value of the replacement component.
• Replaces: string
  Read Only: true

  Maximum Length: 255

  Item number of the component that's being replaced.
• RequiredForRevenueFlag: boolean
  Title: Required for Revenue

  Default Value: false

  Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true.
• RequiredToShipFlag: boolean
  Title: Required to Ship

  Default Value: false

  Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true.
• SalesOrderBasisValue: string
  Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.
• ShowInSales: number
  Value that indicates if the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
• ShowInSalesValue: string
  Value that indicates if the component is visible in the sales application. Values include Yes, Hide Self, and Hide Self and Descendants.
• SoBasis: number
  Title: Sales Order Basis

  Default Value: 2

  Value that indicates the basis to override the default quantity for the option class when a sales order is entered (the default), for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.
• StartDateTime: string (date-time)
  Title: Start Date

  Date and time when a component in a structure begins.
• SubstituteComponent: array Substitute Components
  Title: Substitute Components

  The Substitute Components resource manages the details of a substitute component.
• SuggestedOperationSequence: integer
  Title: Suggested Operation Sequence

  Sequence number suggested by a design engineer for a specific component operation in a manufacturing work definition. Example values are 10, 20, 30, and so on.
• SupplyType: string
  Type of supply for components.
• ToNumber: string
  Title: To End Item Unit Number

  Maximum Length: 30

  Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
• UsePlaceholderFlag: boolean
  Title: Use Placeholder

  A flag indicating if this Option Class item data should be loaded into configurator models.
• WhereUsed: array Where Used for Item Structures
  Title: Where Used for Item Structures

  The Where Used for Item Structures resource gets the items in which this structure is used.
• WipSupplyType: integer
  Title: Supply Type

  Type of supply for components.
• Yield: number
  Title: Yield

  Default Value: 1

  Value that indicates the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.

{
    "type":"object",
    "properties":{
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AbsoluteYield":{
            "title":"Absolute Yield",
            "type":"number",
            "description":"Represents the absolute yield of a component. This value equals to quantity times yield.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcdType":{
            "title":"Change Action",
            "type":"integer",
            "description":"Identifies whether the component is being added, modified, or deleted in a change line.",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-queryable":true
        },
        "AutoRequestMaterialFlag":{
            "title":"Automatically Request Material",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Basis",
            "type":"integer",
            "description":"Value that indicates if the option class quantity can be overridden by sales order. Valid values include None (can override) or Option Class (cannot override).",
            "nullable":true,
            "default":1,
            "x-queryable":true
        },
        "BasisValue":{
            "type":"string",
            "description":"Value that determines if the option class quantity can be overridden by the sales order. Valid values include None or Option Class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the structure.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeId":{
            "type":"integer",
            "description":"Identifies the change order to which the pending component has been added.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revised change line to which pending component is added.",
            "nullable":true,
            "readOnly":true,
            "default":-1,
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":255,
            "type":"string",
            "description":"Change order notice to which the pending component is added.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckATPFlag":{
            "title":"Check ATP",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Comments about a component.",
            "nullable":true,
            "x-queryable":true
        },
        "CompAlternateBomDesignator":{
            "title":"Formula Name",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the context formula for an ingredient.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionType":{
            "title":"Completion Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates how the output item will be reported during work execution.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value used by the manufacturer to define the completion type of products. The values are Automatic, Manual, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ComponentDFF":{
            "title":"Flexfields for Components",
            "type":"array",
            "description":"The Flexfields for Components resource gets the descriptive flexfields associated with the component.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ComponentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ComponentItemClass":{
            "maxLength":255,
            "type":"string",
            "description":"Class of the component item. This attribute is read-only and is not required for an update operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item associated with the component.",
            "nullable":false,
            "x-queryable":true
        },
        "ComponentItemNumber":{
            "type":"string",
            "description":"Number that indicates the item of a component. This attribute is read-only, which can be modified for the create operation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.",
            "nullable":false,
            "x-queryable":true
        },
        "ComponentType":{
            "title":"Material Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of material for the formula.",
            "nullable":false,
            "default":"INPUT",
            "x-queryable":true
        },
        "ComponentTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the type of material. The values include Ingredient or Product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContributeToYield":{
            "title":"Contribute to Yield",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the ingredient quantity should contribute to the yield.",
            "nullable":true,
            "x-queryable":true
        },
        "ContributeToYieldValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the structure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "title":"End Date",
            "type":"string",
            "description":"Date and time when a component in a structure ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceIntRequirements":{
            "title":"Enforce Integer Requirement",
            "type":"number",
            "description":"Value that is used by Oracle Supply Planning Cloud to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "EnforceIntegerRequirementsValue":{
            "type":"string",
            "description":"Value that is used by planning to generate the demand in integer quantities. Values include Round Up, Round Down, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"integer",
            "description":"Number used to locate a specific instance of an item in a structure.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "FromNumber":{
            "title":"From End Item Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that indicates the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementationDateTime":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeOnShipDocsFlag":{
            "title":"Include on Shipping Documents",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InstantiabilityCode":{
            "title":"Instantiability",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the whether a component item is instantiable in an item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "InstantiabilityValue":{
            "type":"string",
            "description":"Value that indicates whether a component item is instantiable in an item structure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemSequenceNumber":{
            "title":"Item Sequence",
            "type":"number",
            "description":"Number that defines the sequence of components in a structure.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the structure was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"Value that indicates the maximum order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"Value that indicates the minimum order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "MutuallyExclusiveFlag":{
            "title":"Mutually Exclusive",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "OldComponentSequenceId":{
            "type":"integer",
            "description":"Reference to the production row when the component is modified in a change line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionalFlag":{
            "title":"Optional",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningPercent":{
            "title":"Planning Percent",
            "type":"number",
            "description":"Distribution percentage for a component. It is used by forecast planning.",
            "nullable":false,
            "default":100,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Primary unit of measure for the item quantities.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryUOMCodeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value in the primary unit of measure for the item quantities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of product for the formula output.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the product type. The values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of component item that is used.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "QuantityRelatedFlag":{
            "title":"Quantity Related",
            "type":"boolean",
            "description":"Value that indicates whether a component is quantity related or not. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ReferenceDesignator":{
            "title":"Reference Designators",
            "type":"array",
            "description":"The Reference Designators resource manages the details of a reference designator.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-item-response"
            }
        },
        "ReplacedBy":{
            "maxLength":255,
            "type":"string",
            "description":"Item number of the replacement component.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ReplacedByFindNumber"
                ]
            },
            "x-queryable":true
        },
        "ReplacedByFindNumber":{
            "type":"integer",
            "description":"New find number value of the replacement component.",
            "nullable":true,
            "x-queryable":false
        },
        "Replaces":{
            "maxLength":255,
            "type":"string",
            "description":"Item number of the component that's being replaced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredForRevenueFlag":{
            "title":"Required for Revenue",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RequiredToShipFlag":{
            "title":"Required to Ship",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SalesOrderBasisValue":{
            "type":"string",
            "description":"Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShowInSales":{
            "type":"number",
            "description":"Value that indicates if the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowInSalesValue":{
            "type":"string",
            "description":"Value that indicates if the component is visible in the sales application. Values include Yes, Hide Self, and Hide Self and Descendants.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SoBasis":{
            "title":"Sales Order Basis",
            "type":"number",
            "description":"Value that indicates the basis to override the default quantity for the option class when a sales order is entered (the default), for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.",
            "nullable":true,
            "default":2,
            "x-queryable":true
        },
        "StartDateTime":{
            "title":"Start Date",
            "type":"string",
            "description":"Date and time when a component in a structure begins.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteComponent":{
            "title":"Substitute Components",
            "type":"array",
            "description":"The Substitute Components resource manages the details of a substitute component.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-SubstituteComponent-item-response"
            }
        },
        "SuggestedOperationSequence":{
            "title":"Suggested Operation Sequence",
            "type":"integer",
            "description":"Sequence number suggested by a design engineer for a specific component operation in a manufacturing work definition. Example values are 10, 20, 30, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyType":{
            "type":"string",
            "description":"Type of supply for components.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ToNumber":{
            "title":"To End Item Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.",
            "nullable":true,
            "x-queryable":true
        },
        "UsePlaceholderFlag":{
            "title":"Use Placeholder",
            "type":"boolean",
            "description":"A flag indicating if this Option Class item data should be loaded into configurator models.",
            "nullable":true,
            "x-queryable":true
        },
        "WhereUsed":{
            "title":"Where Used for Item Structures",
            "type":"array",
            "description":"The Where Used for Item Structures resource gets the items in which this structure is used.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-WhereUsed-item-response"
            }
        },
        "WipSupplyType":{
            "title":"Supply Type",
            "type":"integer",
            "description":"Type of supply for components.",
            "nullable":true,
            "x-queryable":true
        },
        "Yield":{
            "title":"Yield",
            "type":"number",
            "description":"Value that indicates the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Flexfields for Components

Type: array

Title: Flexfields for Components

The Flexfields for Components resource gets the descriptive flexfields associated with the component.

Show Source

• Array of: object itemStructures-Component-ComponentDFF-item-response

{
    "title":"Flexfields for Components",
    "type":"array",
    "description":"The Flexfields for Components resource gets the descriptive flexfields associated with the component.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-ComponentDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : Reference Designators

Type: array

Title: Reference Designators

The Reference Designators resource manages the details of a reference designator.

Show Source

• Array of: object itemStructures-Component-ReferenceDesignator-item-response

{
    "title":"Reference Designators",
    "type":"array",
    "description":"The Reference Designators resource manages the details of a reference designator.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-item-response"
    }
}

Nested Schema : Substitute Components

Type: array

Title: Substitute Components

The Substitute Components resource manages the details of a substitute component.

Show Source

• Array of: object itemStructures-Component-SubstituteComponent-item-response

{
    "title":"Substitute Components",
    "type":"array",
    "description":"The Substitute Components resource manages the details of a substitute component.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-SubstituteComponent-item-response"
    }
}

Nested Schema : Where Used for Item Structures

Type: array

Title: Where Used for Item Structures

The Where Used for Item Structures resource gets the items in which this structure is used.

Show Source

• Array of: object itemStructures-Component-WhereUsed-item-response

{
    "title":"Where Used for Item Structures",
    "type":"array",
    "description":"The Where Used for Item Structures resource gets the items in which this structure is used.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-WhereUsed-item-response"
    }
}

Nested Schema : itemStructures-Component-ComponentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context that references the component.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• ComponentSequenceId: integer
  Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context that references the component.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : itemStructures-Component-ReferenceDesignator-item-response

Type: object

Show Source

• ACDType: integer
  Default Value: 1

  Value that indicates if the reference designator is being added, modified, or deleted through a change line.
• ACDTypeValue: string
  Read Only: true

  Maximum Length: 255

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• ChangeLineId: integer (int64)
  Default Value: -1

  Value that uniquely identifies the change line corresponding to the reference designator.
• ChangeNotice: string
  Maximum Length: 10

  Change order notice to which the service operation added all the structure component changes. This attribute is used when the Needs Approval rule is run.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was created.
• Description: string
  Title: Description

  Maximum Length: 240

  Description for the reference designator.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReferenceDesignator: string
  Title: Reference Designator

  Maximum Length: 15

  Name of the reference designator.
• ReferenceDesignatorDFF: array Flexfields for Reference Designators
  Title: Flexfields for Reference Designators

  The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
• ReferenceDesignatorSequenceId: integer (int64)
  Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.

{
    "type":"object",
    "properties":{
        "ACDType":{
            "type":"integer",
            "description":"Value that indicates if the reference designator is being added, modified, or deleted through a change line.",
            "nullable":true,
            "default":1,
            "x-queryable":true
        },
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change line corresponding to the reference designator.",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":10,
            "type":"string",
            "description":"Change order notice to which the service operation added all the structure component changes. This attribute is used when the Needs Approval rule is run.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the structure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for the reference designator.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the structure was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceDesignator":{
            "title":"Reference Designator",
            "maxLength":15,
            "type":"string",
            "description":"Name of the reference designator.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceDesignatorDFF":{
            "title":"Flexfields for Reference Designators",
            "type":"array",
            "description":"The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ReferenceDesignatorSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Flexfields for Reference Designators

Type: array

Title: Flexfields for Reference Designators

The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.

Show Source

• Array of: object itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response

{
    "title":"Flexfields for Reference Designators",
    "type":"array",
    "description":"The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context that references the reference designator.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RefDesigSequenceId: integer (int64)
  Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.

{
    "type":"object",
    "properties":{
        "RefDesigSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context that references the reference designator.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : itemStructures-Component-SubstituteComponent-item-response

Type: object

Show Source

• ACDType: integer
  Title: Change Action

  Default Value: 1

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• ACDTypeValue: string
  Maximum Length: 255

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• ChangeNotice: string
  Title: Change Notice

  Maximum Length: 10

  Change order notice to which the service operation added all the structure component changes. This attribute is used when Needs Approval rule is run.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was last created.
• EnforceIntegerRequirementsValue: string
  Maximum Length: 255

  Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down, or None.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryUOMValue: string
  Maximum Length: 255

  Primary unit of measure specified for the substitute component.
• Priority: integer
  Priority specified for the substitute component.
• Quantity: number
  Title: Quantity

  Quantity of the substitute component.
• SubstituteComponentDFF: array Flexfields for Substitute Components
  Title: Flexfields for Substitute Components

  The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
• SubstituteComponentId: integer
  Value that uniquely identifies the item associated as the substitute component.
• SubstituteComponentItemNumber: string
  Maximum Length: 255

  Item number of the substitute component.
• SubstituteComponentSequenceId: integer (int64)
  Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.

{
    "type":"object",
    "properties":{
        "ACDType":{
            "title":"Change Action",
            "type":"integer",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeNotice":{
            "title":"Change Notice",
            "maxLength":10,
            "type":"string",
            "description":"Change order notice to which the service operation added all the structure component changes. This attribute is used when Needs Approval rule is run.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the structure was last created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnforceIntegerRequirementsValue":{
            "maxLength":255,
            "type":"string",
            "description":"Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the structure was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "description":"Primary unit of measure specified for the substitute component.",
            "nullable":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority specified for the substitute component.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the substitute component.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteComponentDFF":{
            "title":"Flexfields for Substitute Components",
            "type":"array",
            "description":"The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item associated as the substitute component.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteComponentItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Item number of the substitute component.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubstituteComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Flexfields for Substitute Components

Type: array

Title: Flexfields for Substitute Components

The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.

Show Source

• Array of: object itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response

{
    "title":"Flexfields for Substitute Components",
    "type":"array",
    "description":"The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context that references the substitute component.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubCompSequenceId: integer (int64)
  Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.

{
    "type":"object",
    "properties":{
        "SubCompSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context that references the substitute component.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : itemStructures-Component-WhereUsed-item-response

Type: object

Show Source

• BasisValue: string
  Maximum Length: 80

  Value that indicates how the component quantity is consumed in an assembly. Values include item and lot.
• ComponentBillSequenceId: integer (int64)
  Value that uniquely identifies the parent structure.
• ComponentItemDescription: string
  Maximum Length: 240

  Description of the item of a component.
• ComponentItemNumber: string
  Maximum Length: 300

  Number that indicates the item of a component.
• ComponentPath: string
  Maximum Length: 4000

  Value that represents the hierarchical path of a component item to the root item in a structure.
• ComponentSequenceId: integer (int64)
  Value that uniquely identifies the component in a structure.
• EffectivityControlValue: string
  Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
• EndDateTime: string (date-time)
  Date and time when a component in a structure ends.
• FromSerialNumber: string
  Maximum Length: 30

  Number that indicates the item serial from which the component is effective in a structure. It is valid only for serial effective structures.
• FromUnitNumber: string
  Maximum Length: 30

  Number that indicates the item unit or serial from which the component is effective. It is valid only for unit effective structures.
• ItemClassName: string
  Maximum Length: 250

  Name in metadata that is common to all items that share the category.
• ItemStatusValue: string
  Maximum Length: 240

  Value that defines codes used to control the transaction activity of an item. For example, an item in active status can be customer-order enabled.
• ItemTypeValue: string
  Maximum Length: 80

  Value that indicates grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
• ParentBillSequenceId: integer (int64)
  Value that uniquely identifies the parent structure.
• ParentItemNumber: string
  Number that uniquely identifies the parent identifier for a part, material, product, or service.
• Quantity: number
  Quantity of a component in a structure.
• StartDateTime: string (date-time)
  Date and time when a component in a structure begins.
• StructureName: string
  Name of the structure. This attribute is read-only, which can be modified for the create operation.
• TopItemFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item is the top item where this component is used. If false, then the item is not the top item where this component is used. The default value is false.
• ToSerialNumber: string
  Maximum Length: 30

  Number that identifies the item serial up to which the component is effective in a structure.
• ToUnitNumber: string
  Maximum Length: 30

  Number that identifies the item unit up to which the component is effective.

{
    "type":"object",
    "properties":{
        "BasisValue":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates how the component quantity is consumed in an assembly. Values include item and lot.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentBillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ComponentItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item of a component.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that indicates the item of a component.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentPath":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that represents the hierarchical path of a component item to the root item in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component in a structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectivityControlValue":{
            "type":"string",
            "description":"Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "type":"string",
            "description":"Date and time when a component in a structure ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FromSerialNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that indicates the item serial from which the component is effective in a structure. It is valid only for serial effective structures.",
            "nullable":true,
            "x-queryable":true
        },
        "FromUnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that indicates the item unit or serial from which the component is effective. It is valid only for unit effective structures.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemClassName":{
            "maxLength":250,
            "type":"string",
            "description":"Name in metadata that is common to all items that share the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemStatusValue":{
            "maxLength":240,
            "type":"string",
            "description":"Value that defines codes used to control the transaction activity of an item. For example, an item in active status can be customer-order enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemTypeValue":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentBillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentItemNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the parent identifier for a part, material, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of a component in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "type":"string",
            "description":"Date and time when a component in a structure begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StructureName":{
            "type":"string",
            "description":"Name of the structure. This attribute is read-only, which can be modified for the create operation.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSerialNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the item serial up to which the component is effective in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ToUnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the item unit up to which the component is effective.",
            "nullable":true,
            "x-queryable":true
        },
        "TopItemFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is the top item where this component is used. If false, then the item is not the top item where this component is used. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

ComponentDFF

Operation: /fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/ComponentDFF

Parameters:

• BillSequenceId: $request.path.BillSequenceId
• ComponentSequenceId: $request.path.ComponentSequenceId

The Flexfields for Components resource gets the descriptive flexfields associated with the component.

ReferenceDesignator

Operation: /fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/ReferenceDesignator

Parameters:

• BillSequenceId: $request.path.BillSequenceId
• ComponentSequenceId: $request.path.ComponentSequenceId

The Reference Designators resource manages the details of a reference designator.

SubstituteComponent

Operation: /fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/SubstituteComponent

Parameters:

• BillSequenceId: $request.path.BillSequenceId
• ComponentSequenceId: $request.path.ComponentSequenceId

The Substitute Components resource manages the details of a substitute component.

WhereUsed

Operation: /fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/WhereUsed

Parameters:

• BillSequenceId: $request.path.BillSequenceId
• ComponentSequenceId: $request.path.ComponentSequenceId

The Where Used for Item Structures resource gets the items in which this structure is used.

Back to Top

Examples

This example describes how to get one component.

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/itemStructures/BillSequenceId/child/Component/ComponentSequenceId"

For example, the following command gets one component where the component sequence identifier is 300100152477061:

curl -u username:password "https://servername/fscmRestApi/resources/version/itemStructures/300100159234307/child/Component/300100159297408"

Example Response Body

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

{
    "ComponentSequenceId": 300100159297408,
    "OrganizationId": "204",
    "ComponentItemNumber": "JUN26_PIM001_BOM1",
    "ComponentItemId": "300100159234167",
    "ChangeNotice": "JUN26_CCO001",
    "ChangeLineId": 300100159295698,
    "ItemSequenceNumber": 10,
    "Quantity": 1,
    "Yield": 1,
    "Comments": null,
    "StartDateTime": "2018-06-27T05:39:33+00:00",
    "EndDateTime": null,
    "ImplementationDateTime": null,
    "FromNumber": null,
    "ToNumber": null,
    "PlanningPercent": 100,
    "BasisType": 1,
    "BasisValue": "Variable",
    "EnforceIntRequirements": 0,
    "EnforceIntegerRequirementsValue": "None",
    "WipSupplyType": 1,
    "SupplyType": "Push",
    "AutoRequestMaterialFlag": true,
    "MinimumQuantity": null,
    "MaximumQuantity": null,
    "OptionalFlag": false,
    "MutuallyExclusiveFlag": false,
    "CheckATPFlag": false,
    "SoBasis": 2,
    "SalesOrderBasisValue": "None",
    "InstantiabilityCode": null,
    "InstantiabilityValue": null,
    "ShowInSales": null,
    "ShowInSalesValue": null,
    "RequiredToShipFlag": false,
    "RequiredForRevenueFlag": false,
    "IncludeOnShipDocsFlag": false,
    "CreationDateTime": "2018-06-27T05:26:25.272+00:00",
    "LastUpdateDateTime": "2018-06-28T02:49:11.509+00:00",
    "BillSequenceId": 300100159234307,
    "PrimaryUOMValue": "Each",
    "PrimaryUOMCode": "Ea",
    "PrimaryUOMCodeValue": "Each",
    "ACDTypeValue": "Updated",
...
}

Back to Top