Jump to

• Request
• Response
• Examples

Get all

get

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

Request

Path Parameters

• BillSequenceId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey
    Finder Variables
    • ComponentSequenceId; integer;
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ACDTypeValue; string; Read Only: This attribute specifies whether the substitute component is being added, modified, or deleted through a change line
  • AbsoluteYield; number; Absolute yield of a component. The value equals quantity times yield.
  • AcdType; integer; Identifies whether the component is being added, modified, or deleted in a change line.
  • AutoRequestMaterialFlag; boolean; A flag that indicates if a move order is automatically created for a material at work order release.
  • BasisType; integer
  • BasisValue; string; An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
  • BillSequenceId; integer
  • ChangeId; integer; Identifies the change order to which the pending component has been added.
  • ChangeLineId; integer; Read Only: This attribute provides the revised line the pending component is added to.
  • ChangeNotice; string; Read Only: This attribute provides the Change Order Notice to which the pending component is added.
  • CheckATPFlag; boolean; A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Comments; string; An attribute value that represents comments about a component.
  • CompAlternateBomDesignator; string; Indicates the context formula for an ingredient.
  • CompletionType; string; Indicates how the output item will be reported during work execution.
  • CompletionTypeValue; string; Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None.
  • ComponentItemClass; string; The component item's item class. This attribute is read only.
  • ComponentItemId; string
  • ComponentItemNumber; string; An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.
  • ComponentSequenceId; integer; A unique identifier for an component in a structure. This attribute is read only and is not required for an update operation.
  • ComponentType; string; Indicates the type of material for the formula.
  • ComponentTypeValue; string; Indicates the type of material. The values include Ingredient or Product.
  • ContributeToYield; string; Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.
  • ContributeToYieldValue; string; Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
  • CreatedBy; string; Who column: An attribute which indicates the user that created the structure
  • CreationDateTime; string; Who column: An attribute that indicates the date and time of the creation of the component.
  • EndDateTime; string; The date and time on which a component in a structure ends.
  • EnforceIntRequirements; number
  • EnforceIntegerRequirementsValue; string; An attribute value used by planning to generate the demand in integer quantities. The values include Round Up, Round Down or None.
  • FindNumber; integer; An attribute value that holds find number for the component.
  • FromNumber; string; The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • ImplementationDateTime; string; Read Only: This attributes provides the timestamp when the component was implemented as production row. This attribute can be used to differentiate among pending and production components. For pending components this will be null.
  • IncludeOnShipDocsFlag; boolean; A flag value that indicates if a component is displayed on shipping documentation.
  • InstantiabilityCode; string
  • InstantiabilityValue; string; A unique identifier indicating whether a component item is instantiable in an item structure.
  • ItemSequenceNumber; number; A unique number which defines the sequence of components in a structure.
  • LastUpdateDateTime; string; Who column: An attribute which indicates the date and time of the last update of the component.
  • LastUpdateLogin; string; Who column: An attribute which indicates the user that logged in last for the structure.
  • LastUpdatedBy; string; Who column: An attribute which indicates the user that last updated the structure.
  • MaximumQuantity; number; An attribute that value indicates the maximum quantity allowed on an order.
  • MinimumQuantity; number; An attribute that value indicates the minimum quantity allowed on an order.
  • MutuallyExclusiveFlag; boolean; A flag indicating if one or more options under this Option Class can be chosen.
  • OldComponentSequenceId; integer; Reference to the production row when the component is modified in a change line.
  • OptionalFlag; boolean; A flag indicating if component is optional for a structure.
  • OrganizationId; string
  • PlanningPercent; number; An attribute used by forecast planning that represents the distribution percentage for a component.
  • PrimaryUOMCode; string
  • PrimaryUOMCodeValue; string; A value which indicates the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table.
  • PrimaryUOMValue; string
  • ProductType; string; Type of product for the formula output.
  • ProductTypeValue; string; Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
  • Quantity; number; An attribute value the represents the quantity of component item used.
  • QuantityRelatedFlag; boolean; An attribute 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.
  • ReplacedBy; string; The item number of the replacement component.
  • Replaces; string; The item number of the component that is being replaced.
  • RequiredForRevenueFlag; boolean; A flag indicating if component is required to recognize revenue before you ship the order.
  • RequiredToShipFlag; boolean; Flag indicating if component is required to ship
  • SalesOrderBasisValue; string; An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
  • ShowInSales; number
  • ShowInSalesValue; string; An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
  • SoBasis; number
  • StartDateTime; string; The date and time on which a component in a structure begins.
  • SuggestedOperationSequence; integer; An attribute value that holds the suggested operation sequence.
  • SupplyType; string; An attribute indicating a supply type for components.
  • ToNumber; string; The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • UsePlaceholderFlag; boolean; A flag indicating if this Option Class item data should be loaded into configurator models.
  • WipSupplyType; integer
  • Yield; number; An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-item-response"
    }
}

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-item-response

Type: object

Show Source

• AbsoluteYield: number
  Title: Absolute Yield

  Read Only: true

  Absolute yield of a component. The value equals 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

  Read Only: This attribute specifies whether 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

  A flag that indicates if a move order is automatically created for a material at work order release.
• BasisType: integer
  Title: Basis

  Default Value: 1
• BasisValue: string
  An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
• BillSequenceId: integer
• ChangeId: integer
  Identifies the change order to which the pending component has been added.
• ChangeLineId: integer
  Read Only: true

  Default Value: -1

  Read Only: This attribute provides the revised line the pending component is added to.
• ChangeNotice: string
  Read Only: true

  Maximum Length: 255

  Read Only: This attribute provides the Change Order Notice to which the pending component is added.
• CheckATPFlag: boolean
  Title: Check ATP

  Default Value: false

  A flag indicating to check available to promise and/or capable to promise information when placing demand.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  An attribute value that represents 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 type of completion of products. Values include Automatic, Manual, or None.
• ComponentDFF: array ComponentDFF
  A customer-specified field used to capture a characteristic of a component.
• ComponentItemClass: string
  Read Only: true

  Maximum Length: 255

  The component item's item class. This attribute is read only.
• ComponentItemId: string
  Maximum Length: 240
• ComponentItemNumber: string
  An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.
• ComponentItemStructureName: string
  Maximum Length: 255

  Indicates the context formula for an ingredient.
• ComponentSequenceId: integer
  A unique identifier for an 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 contributes to the yield. Values are Yes and No.
• 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

  Who column: An attribute which indicates the user that created the structure
• CreationDateTime: string (date-time)
  Read Only: true

  Who column: An attribute that indicates the date and time of the creation of the component.
• EndDateTime: string (date-time)
  Title: End Date

  The date and time on which a component in a structure ends.
• EnforceIntegerRequirementsValue: string
  An attribute value used by planning to generate the demand in integer quantities. The values include Round Up, Round Down or None.
• EnforceIntRequirements: number
  Title: Enforce Integer Requirement

  Default Value: 0
• FindNumber: integer
  Title: Find Number

  Default Value: 1

  An attribute value that holds find number for the component.
• FromNumber: string
  Title: From End Item Unit Number

  Maximum Length: 30

  The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
• ImplementationDateTime: string (date-time)
  Title: Effective Date

  Read Only: true

  Read Only: This attributes provides the timestamp when the component was implemented as production row. This attribute can be used to differentiate among pending and production components. For pending components this will be null.
• IncludeOnShipDocsFlag: boolean
  Title: Include on Shipping Documents

  Default Value: false

  A flag value that indicates if a component is displayed on shipping documentation.
• InstantiabilityCode: string
  Title: Instantiability

  Maximum Length: 30
• InstantiabilityValue: string
  A unique identifier indicating whether a component item is instantiable in an item structure.
• ItemSequenceNumber: number
  Title: Item Sequence

  A unique number which defines the sequence of components in a structure.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Who column: An attribute which indicates the date and time of the last update of the component.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: An attribute which indicates the user that last updated the structure.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Who column: An attribute which indicates the user that logged in last for the structure.
• links: array Links
  Title: Links

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

  An attribute that value indicates the maximum quantity allowed on an order.
• MinimumQuantity: number
  Title: Minimum Quantity

  An attribute that value indicates the minimum quantity allowed on an order.
• MutuallyExclusiveFlag: boolean
  Title: Mutually Exclusive

  Default Value: false

  A flag indicating if one or more options under this Option Class can be chosen.
• 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

  A flag indicating if component is optional for a structure.
• OrganizationId: string
  Maximum Length: 240
• PlanningPercent: number
  Title: Planning Percent

  Default Value: 100

  An attribute used by forecast planning that represents the distribution percentage for a component.
• PrimaryUOMCode: string
  Maximum Length: 30
• PrimaryUOMCodeValue: string
  Maximum Length: 255

  A value which indicates the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table.
• PrimaryUOMValue: string
  Read Only: true

  Maximum Length: 255
• ProductType: string
  Title: Product Type

  Maximum Length: 30

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

  Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
• Quantity: number
  Title: Quantity

  Default Value: 1

  An attribute value the represents the quantity of component item used.
• QuantityRelatedFlag: boolean
  Title: Quantity Related

  Default Value: false

  An attribute 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 ReferenceDesignator
  A set of reference designators that mark the location of the component in an item structure.
• ReplacedBy: string
  Maximum Length: 255

  The item number of the replacement component.
• ReplacedByFindNumber: integer
  An attribute value that holds the replaced by find number.
• Replaces: string
  Read Only: true

  Maximum Length: 255

  The item number of the component that is being replaced.
• RequiredForRevenueFlag: boolean
  Title: Required for Revenue

  Default Value: false

  A flag indicating if component is required to recognize revenue before you ship the order.
• RequiredToShipFlag: boolean
  Title: Required to Ship

  Default Value: false

  Flag indicating if component is required to ship
• SalesOrderBasisValue: string
  An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
• ShowInSales: number
• ShowInSalesValue: string
  An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
• SoBasis: number
  Title: Sales Order Basis

  Default Value: 2
• StartDateTime: string (date-time)
  Title: Start Date

  The date and time on which a component in a structure begins.
• SubstituteComponent: array SubstituteComponent
  A set of items that can be used as substitutes for a component in a structure
• SuggestedOperationSequence: integer
  Title: Suggested Operation Sequence

  An attribute value that holds the suggested operation sequence.
• SupplyType: string
  An attribute indicating a supply type for components.
• ToNumber: string
  Title: To End Item Unit Number

  Maximum Length: 30

  The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
• UsePlaceholderFlag: boolean
  Title: Use Placeholder

  A flag indicating if this Option Class item data should be loaded into configurator models.
• WhereUsed: array WhereUsed
• WipSupplyType: integer
  Title: Supply Type
• Yield: number
  Title: Yield

  Default Value: 1

  An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.

{
    "type":"object",
    "properties":{
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Read Only: This attribute specifies whether 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":"Absolute yield of a component. The value equals 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":"A flag that indicates if a move order is automatically created for a material at work order release.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Basis",
            "type":"integer",
            "nullable":true,
            "default":1,
            "x-queryable":true
        },
        "BasisValue":{
            "type":"string",
            "description":"An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "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":"Read Only: This attribute provides the revised line the pending component is added to.",
            "nullable":true,
            "readOnly":true,
            "default":-1,
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":255,
            "type":"string",
            "description":"Read Only: This attribute provides the Change Order Notice to which the pending component is added.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckATPFlag":{
            "title":"Check ATP",
            "type":"boolean",
            "description":"A flag indicating to check available to promise and/or capable to promise information when placing demand.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"An attribute value that represents 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 type of completion of products. Values include Automatic, Manual, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ComponentDFF":{
            "type":"array",
            "description":"A customer-specified field used to capture a characteristic of a component.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ComponentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ComponentItemClass":{
            "maxLength":255,
            "type":"string",
            "description":"The component item's item class. This attribute is read only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ComponentItemNumber":{
            "type":"string",
            "description":"An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ComponentItemStructureName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the context formula for an ingredient.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"A unique identifier for an 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 contributes to the yield. Values are Yes and No.",
            "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":"Who column: An attribute which indicates the user that created the structure",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Who column: An attribute that indicates the date and time of the creation of the component.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time on which a component in a structure ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceIntRequirements":{
            "title":"Enforce Integer Requirement",
            "type":"number",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "EnforceIntegerRequirementsValue":{
            "type":"string",
            "description":"An attribute value used by planning to generate the demand in integer quantities. The values include Round Up, Round Down or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"integer",
            "description":"An attribute value that holds find number for the component.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "FromNumber":{
            "title":"From End Item Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The item unit number or serial number from which the component is effective. Valid only for unit or serial  effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementationDateTime":{
            "title":"Effective Date",
            "type":"string",
            "description":"Read Only: This attributes provides the timestamp when the component was implemented as production row. This attribute can be used to differentiate among pending and production components. For pending components this will be null.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeOnShipDocsFlag":{
            "title":"Include on Shipping Documents",
            "type":"boolean",
            "description":"A flag value that indicates if a component is displayed on shipping documentation.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InstantiabilityCode":{
            "title":"Instantiability",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "InstantiabilityValue":{
            "type":"string",
            "description":"A unique identifier indicating 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":"A unique number which defines the sequence of components in a structure.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Who column: An attribute which indicates the date and time of the last update of the component.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: An attribute which indicates the user that logged in last for the structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: An attribute which indicates the user that last updated the structure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"An attribute that value indicates the maximum quantity allowed on an order.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"An attribute that value indicates the minimum quantity allowed on an order.",
            "nullable":true,
            "x-queryable":true
        },
        "MutuallyExclusiveFlag":{
            "title":"Mutually Exclusive",
            "type":"boolean",
            "description":"A flag indicating if one or more options under this Option Class can be chosen.",
            "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":"A flag indicating if component is optional for a structure.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningPercent":{
            "title":"Planning Percent",
            "type":"number",
            "description":"An attribute used by forecast planning that represents the distribution percentage for a component.",
            "nullable":false,
            "default":100,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryUOMCodeValue":{
            "maxLength":255,
            "type":"string",
            "description":"A value which indicates the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of product for the formula output.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Type of product. 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":"An attribute value the represents the quantity of component item used.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "QuantityRelatedFlag":{
            "title":"Quantity Related",
            "type":"boolean",
            "description":"An attribute 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":{
            "type":"array",
            "description":"A set of reference designators that mark the location of the component in an item structure.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-item-response"
            }
        },
        "ReplacedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The item number of the replacement component.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ReplacedByFindNumber"
                ]
            },
            "x-queryable":true
        },
        "ReplacedByFindNumber":{
            "type":"integer",
            "description":"An attribute value that holds the replaced by find number.",
            "nullable":true,
            "x-queryable":false
        },
        "Replaces":{
            "maxLength":255,
            "type":"string",
            "description":"The item number of the component that is being replaced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredForRevenueFlag":{
            "title":"Required for Revenue",
            "type":"boolean",
            "description":"A flag indicating if component is required  to recognize revenue before you ship the order.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RequiredToShipFlag":{
            "title":"Required to Ship",
            "type":"boolean",
            "description":"Flag indicating if component is required to ship",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SalesOrderBasisValue":{
            "type":"string",
            "description":"An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShowInSales":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ShowInSalesValue":{
            "type":"string",
            "description":"An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SoBasis":{
            "title":"Sales Order Basis",
            "type":"number",
            "nullable":true,
            "default":2,
            "x-queryable":true
        },
        "StartDateTime":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time on which a component in a structure begins.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteComponent":{
            "type":"array",
            "description":"A set of items that can be used as substitutes for a component in a structure",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-SubstituteComponent-item-response"
            }
        },
        "SuggestedOperationSequence":{
            "title":"Suggested Operation Sequence",
            "type":"integer",
            "description":"An attribute value that holds the suggested operation sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyType":{
            "type":"string",
            "description":"An attribute indicating a supply type for components.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ToNumber":{
            "title":"To End Item Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The item unit number or serial number up to which the component is effective. Valid only for unit or serial  effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.",
            "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":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-WhereUsed-item-response"
            }
        },
        "WipSupplyType":{
            "title":"Supply Type",
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "Yield":{
            "title":"Yield",
            "type":"number",
            "description":"An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an 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 : ComponentDFF

Type: array

A customer-specified field used to capture a characteristic of a component.

Show Source

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

{
    "type":"array",
    "description":"A customer-specified field used to capture a characteristic of a 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 : ReferenceDesignator

Type: array

A set of reference designators that mark the location of the component in an item structure.

Show Source

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

{
    "type":"array",
    "description":"A set of reference designators that mark the location of the component in an item structure.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-item-response"
    }
}

Nested Schema : SubstituteComponent

Type: array

A set of items that can be used as substitutes for a component in a structure

Show Source

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

{
    "type":"array",
    "description":"A set of items that can be used as substitutes for a component in a structure",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-SubstituteComponent-item-response"
    }
}

Nested Schema : WhereUsed

Type: array

Show Source

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

{
    "type":"array",
    "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

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• ComponentSequenceId: integer
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ComponentSequenceId":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "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",
                "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

  Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line
• ACDTypeValue: string
  Read Only: true

  Maximum Length: 255

  Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line
• ChangeLineId: integer (int64)
  Default Value: -1

  Read Only: This attribute provides the revised line the reference designator is added/modified
• ChangeNotice: string
  Maximum Length: 10

  Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified
• CreationDateTime: string (date-time)
  Read Only: true

  Who column: An attribute that indicates the date and time of the creation of the reference designator
• Description: string
  Title: Description

  Maximum Length: 240

  An attribute value that describes the reference designator code
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Who column: An attribute which indicates the date and time of the last update of the reference designator
• links: array Links
  Title: Links

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

  Maximum Length: 15

  An attribute that represents the code of a reference designator
• ReferenceDesignatorDFF: array ReferenceDesignatorDFF
  Descriptive Flexfield extensions for structure reference designators.
• ReferenceDesignatorSequenceId: integer (int64)
  An unique identifier for the reference designator in a structure.

{
    "type":"object",
    "properties":{
        "ACDType":{
            "type":"integer",
            "description":"Read Only: This attribute specifies the acdType code which defines whether 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":"Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Read Only: This attribute provides the revised line the reference designator is added/modified",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":10,
            "type":"string",
            "description":"Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Who column: An attribute that indicates the date and time of the creation of the reference designator",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"An attribute value that describes the reference designator code",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Who column: An attribute which indicates the date and time of the last update of the reference designator",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceDesignator":{
            "title":"Reference Designator",
            "maxLength":15,
            "type":"string",
            "description":"An attribute that represents the code of a reference designator",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceDesignatorDFF":{
            "type":"array",
            "description":"Descriptive Flexfield extensions for structure reference designators.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ReferenceDesignatorSequenceId":{
            "type":"integer",
            "description":"An unique identifier for the reference designator in a structure.",
            "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 : ReferenceDesignatorDFF

Type: array

Descriptive Flexfield extensions for structure reference designators.

Show Source

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

{
    "type":"array",
    "description":"Descriptive Flexfield extensions for structure reference designators.",
    "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

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RefDesigSequenceId: integer (int64)

{
    "type":"object",
    "properties":{
        "RefDesigSequenceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "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",
                "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

  Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line
• ACDTypeValue: string
  Maximum Length: 255

  Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line
• ChangeNotice: string
  Title: Change Notice

  Maximum Length: 10

  Read Only: This attribute provides the Change Order Notice to which the substitute component is added/modified
• CreationDateTime: string (date-time)
  Read Only: true

  Who column: An attribute that indicates the date and time of the creation of the substitute component
• 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

  Who column: An attribute which indicates the date and time of the last update of the substitute component
• links: array Links
  Title: Links

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

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

  An attribute value the represents the quantity of substitute component item used.
• SubstituteComponentDFF: array SubstituteComponentDFF
  Descriptive Flexfield extensions for structure reference designators.
• SubstituteComponentId: integer
• SubstituteComponentItemNumber: string
  Maximum Length: 255

  An attribute that represents the item number of a substitute component.
• SubstituteComponentSequenceId: integer (int64)
  An unique identifier for the substitute component in a structure.

{
    "type":"object",
    "properties":{
        "ACDType":{
            "title":"Change Action",
            "type":"integer",
            "description":"Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeNotice":{
            "title":"Change Notice",
            "maxLength":10,
            "type":"string",
            "description":"Read Only: This attribute provides the Change Order Notice to which the substitute component is added/modified",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Who column: An attribute that indicates the date and time of the creation of the substitute component",
            "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":"Who column: An attribute which indicates the date and time of the last update of the substitute component",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "description":"Read Only: 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":"An attribute value the represents the quantity of substitute component item used.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteComponentDFF":{
            "type":"array",
            "description":"Descriptive Flexfield extensions for structure reference designators.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SubstituteComponentId":{
            "type":"integer",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteComponentItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"An attribute that represents the item number of a substitute component.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubstituteComponentSequenceId":{
            "type":"integer",
            "description":"An unique identifier for the substitute component in a structure.",
            "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 : SubstituteComponentDFF

Type: array

Descriptive Flexfield extensions for structure reference designators.

Show Source

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

{
    "type":"array",
    "description":"Descriptive Flexfield extensions for structure reference designators.",
    "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

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubCompSequenceId: integer (int64)

{
    "type":"object",
    "properties":{
        "SubCompSequenceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "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",
                "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

  An attribute value that indicates how the component quantity is consumed in an assembly. The values include item and lot.
• ComponentBillSequenceId: integer (int64)
  A unique identifier of the parent structure.
• ComponentItemDescription: string
  Maximum Length: 240

  An attribute value that represents the item description of a component.
• ComponentItemNumber: string
  Maximum Length: 300

  An attribute value that represents the item number of a component.
• ComponentPath: string
  Maximum Length: 4000

  An attribute value that represents the hierarchical Path of a component item to the root item in a structure.
• ComponentSequenceId: integer (int64)
  A unique identifier for an Component in a structure.
• EffectivityControlValue: string
  An attribute which value indicates the way effectively is controlled within a structure. The values include Date, Unit Number, or Serial Number.
• EndDateTime: string (date-time)
  The date and time on which a component in a structure ends.
• FromSerialNumber: string
  Maximum Length: 30

  Starting Item serial number that a component is effective in a structure. Valid only for serial effective structures.
• FromUnitNumber: string
  Maximum Length: 30

  Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit effective structures.
• ItemClassName: string
  Maximum Length: 250

  An attribute that value provides metadata common to all items that share the category.
• ItemStatusValue: string
  Maximum Length: 240

  An attribute 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

  An attribute that indicates a grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes. For example, each account generator item type (such as FA account generator) contains a group of processes for determining how an accounting flexfield code combination is created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  A name of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
• ParentBillSequenceId: integer (int64)
  A unique identifier for parent structure.
• ParentItemNumber: string
  An attribute for the parent of an identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
• Quantity: number
  An attribute value which represent the quantity of a component in structure.
• StartDateTime: string (date-time)
  The date and time on which a component in a structure begins.
• StructureName: string
  An attribute which value represents the name of a structure.
• TopItemFlag: boolean
  Maximum Length: 1

  A flag that identifies the root item for the explosion of the structure.
• ToSerialNumber: string
  Maximum Length: 30

  An attribute value which represents the serial number at the beginning of the end item (or root item) serial number range during which a given record is available.
• ToUnitNumber: string
  Maximum Length: 30

  An attribute value which represents the Unit number at the beginning of the end item (or root item) unit number range during which a given record is available.

{
    "type":"object",
    "properties":{
        "BasisValue":{
            "maxLength":80,
            "type":"string",
            "description":"An attribute value that indicates how the component quantity is consumed in an assembly. The values include item and lot.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentBillSequenceId":{
            "type":"integer",
            "description":"A unique identifier of the parent structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ComponentItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"An attribute value that represents the item description of a component.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"An attribute value that represents the item number of a component.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentPath":{
            "maxLength":4000,
            "type":"string",
            "description":"An attribute 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":"A unique identifier for an Component in a structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectivityControlValue":{
            "type":"string",
            "description":"An attribute which value indicates the way effectively is controlled within a  structure. The values include Date, Unit Number, or Serial Number.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "type":"string",
            "description":"The date and time on which a component in a structure ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FromSerialNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Starting Item serial number  that a component is effective in a structure. Valid only for serial  effective structures.",
            "nullable":true,
            "x-queryable":true
        },
        "FromUnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit effective structures.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemClassName":{
            "maxLength":250,
            "type":"string",
            "description":"An attribute that value provides metadata common to all items that share the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemStatusValue":{
            "maxLength":240,
            "type":"string",
            "description":"An attribute 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":"An attribute that indicates a grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes. For example, each account generator item type (such as FA account generator) contains a group of processes for determining how an accounting flexfield code combination is created.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"A name of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentBillSequenceId":{
            "type":"integer",
            "description":"A unique identifier for parent structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentItemNumber":{
            "type":"string",
            "description":"An attribute for the parent of an identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"An attribute value which represent the quantity of a component in structure.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "type":"string",
            "description":"The date and time on which a component in a structure begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StructureName":{
            "type":"string",
            "description":"An attribute which value represents the name of a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSerialNumber":{
            "maxLength":30,
            "type":"string",
            "description":"An attribute value which represents the serial number at the beginning of the end item (or root item) serial number range during which a given record is available.",
            "nullable":true,
            "x-queryable":true
        },
        "ToUnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"An attribute value which represents the Unit number at the beginning of the end item (or root item) unit number range during which a given record is available.",
            "nullable":true,
            "x-queryable":true
        },
        "TopItemFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"A flag that identifies the root item for the explosion of the structure.",
            "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"
    }
}

Back to Top

Examples

This example describes how to get all components.

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"

For example, the following command gets all components where the bill sequence identifier is 300100152430388:

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

Example Response Body

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

{
    "items": [
        {
            "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",",
            "ACDTypeValue": "Added",
...
},
...
],
...
}

Back to Top