Jump to

• Request
• Response

Get all component items

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/ComponentItems

Request

Path Parameters

• SimulationSetId(required): integer(int64)
  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 Finds the component item using the primary key.
    Finder Variables
    • BillSequenceId; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
    • BillSequenceIdSecondary; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
    • ComponentSequenceId; integer; Value that uniquely identifies the component on the source application instance.
    • NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
    • NewPlanIdSecondary; integer; Value that uniquely identifies the new plan that the duplication process creates.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • OrganizationIdSecondary; integer; Value that uniquely identifies the organization.
    • PlanId; integer; Value that uniquely identifies the plan.
    • PlanIdSecondary; integer; Value that uniquely identifies the plan.
    • SimulationSetId; integer; Value that uniquely identifies the simulation set.
    • SimulationSetIdSecondary; integer; Value that uniquely identifies the simulation set.
• 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:
  

  • AssemblyItem; string; Name of the assembly item.
  • AssemblyItemDescription; string; Description of the assembly item.
  • AssemblyItemId; integer; Unique identifier of the assembly item.
  • AssemblyItemUOM; string; Unit of measure of the assembly item.
  • AssemblyItemUOMCode; string; Unit of measure code of the assembly item.
  • AssemblyQuantity; number; Quantity of the assembly item.
  • Basis; string; Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.
  • BillSequenceId; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
  • BillSequenceIdSecondary; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
  • ChangeIndicatorFlag; boolean; Value that identifies whether the component item has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.
  • ComponentItem; string; Name of the component item being consumed.
  • ComponentItemDescription; string; Description of the component item being consumed.
  • ComponentItemEffectiveEndDate; string; Start date of effectivity for this component.
  • ComponentItemEffectiveStartDate; string; End date of effectivity for this component.
  • ComponentItemId; integer; Unique identifier of the component item.
  • ComponentItemUOM; string; Unit of measure of the component item.
  • ComponentItemUOMCode; string; Unit of measure code of the component item.
  • ComponentSequenceId; integer; Value that uniquely identifies the component on the source application instance.
  • ComponentUsageQuantity; number; Quantity of the component to build one unit of item based on the component's primary UOM.
  • ComponentYield; number; Factor used to multiply component quantity with to obtain the total quantity used of a component that actually becomes part of an assembly.
  • EnforceIntegerRequirement; string; Specifies whether the result of a component's calculated quantity or inverse quantity is required to be an integer. Valid values for this option are None, Round up, and Round down.
  • FindNumber; integer; Number used to locate a specific instance of an item in a structure. This number enables users to define multiple occurrences of the same component for an assembly in its item structure.
  • ItemSequence; integer; Number that indicates the sequence for a component item for a work order operation.
  • ItemStructureName; string; Name for the categorization of an item structure, such as a design structure or manufacturing bill of material, that controls the usage and behavior of the structure.
  • LastUpdateDate; string; Date when the component item was last updated.
  • LastUpdatedBy; string; Name of the user who last updated the component item.
  • NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
  • NewPlanIdSecondary; integer; Value that uniquely identifies the new plan that the duplication process creates.
  • NotesCount; integer; Number of notes associated with this component item.
  • OperationSequenceNumber; integer; Order in which the operation occurs.
  • Organization; string; Name of the organization.
  • OrganizationCode; string; Organization code for the assembly item.
  • OrganizationId; integer; Unique identifier of the organization.
  • OrganizationIdSecondary; integer; Unique identifier of the organization.
  • PlanId; integer; Value that uniquely identifies the supply plan associated with the component item
  • PlanIdSecondary; integer; Value that uniquely identifies the supply plan associated with the component item
  • PlanningPercentage; number; Planning factor for this component as a percentage.
  • Primary; string; Indicates if the component item is the primary item structure.
  • SimulationSetId; integer; Value that uniquely identifies the simulation set.
  • SimulationSetIdSecondary; integer; Value that uniquely identifies the simulation set.
  • SupplyType; string; Value that indicates the supply type for components. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.
  • WorkDefinitionName; string; Name of the work definition associated with this item structure.
• 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 : simulationSets-ComponentItems

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/simulationSets-ComponentItems-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object simulationSets-ComponentItems-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/simulationSets-ComponentItems-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 : simulationSets-ComponentItems-item-response

Type: object

Show Source

• AssemblyItem: string
  Title: Assembly Item

  Maximum Length: 250

  Name of the assembly item.
• AssemblyItemDescription: string
  Title: Assembly Item Description

  Maximum Length: 240

  Description of the assembly item.
• AssemblyItemId: integer
  Unique identifier of the assembly item.
• AssemblyItemUOM: string
  Title: Assembly Item UOM

  Maximum Length: 400

  Unit of measure of the assembly item.
• AssemblyItemUOMCode: string
  Title: Assembly Item UOM

  Maximum Length: 3

  Unit of measure code of the assembly item.
• AssemblyQuantity: number
  Title: Assembly Quantity

  Quantity of the assembly item.
• Basis: string
  Title: Basis

  Read Only: true

  Maximum Length: 80

  Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.
• BillSequenceId: integer
  Value that uniquely identifies the sequence in which a component is used within an operation.
• BillSequenceIdSecondary: integer
  Value that uniquely identifies the sequence in which a component is used within an operation.
• ChangeIndicatorFlag: boolean
  Read Only: true

  Value that identifies whether the component item has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.
• ComponentItem: string
  Title: Component Item

  Maximum Length: 250

  Name of the component item being consumed.
• ComponentItemDescription: string
  Title: Component Description

  Maximum Length: 240

  Description of the component item being consumed.
• ComponentItemEffectiveEndDate: string (date)
  Title: Component Item Effective End Date

  Start date of effectivity for this component.
• ComponentItemEffectiveStartDate: string (date)
  Title: Component Item Effective Start Date

  End date of effectivity for this component.
• ComponentItemId: integer
  Unique identifier of the component item.
• ComponentItemUOM: string
  Title: Component UOM

  Maximum Length: 400

  Unit of measure of the component item.
• ComponentItemUOMCode: string
  Maximum Length: 3

  Unit of measure code of the component item.
• ComponentSequenceId: integer
  Value that uniquely identifies the component on the source application instance.
• ComponentUsageQuantity: number
  Title: Usage Quantity

  Quantity of the component to build one unit of item based on the component's primary UOM.
• ComponentYield: number
  Title: Component Yield

  Factor used to multiply component quantity with to obtain the total quantity used of a component that actually becomes part of an assembly.
• EnforceIntegerRequirement: string
  Title: Enforce Integer Requirement

  Read Only: true

  Maximum Length: 80

  Specifies whether the result of a component's calculated quantity or inverse quantity is required to be an integer. Valid values for this option are None, Round up, and Round down.
• FindNumber: integer
  Title: Find Number

  Number used to locate a specific instance of an item in a structure. This number enables users to define multiple occurrences of the same component for an assembly in its item structure.
• ItemSequence: integer
  Title: Item Sequence

  Number that indicates the sequence for a component item for a work order operation.
• ItemStructureName: string
  Title: Item Structure Name

  Maximum Length: 80

  Name for the categorization of an item structure, such as a design structure or manufacturing bill of material, that controls the usage and behavior of the structure.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the component item was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the component item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewPlanId: integer (int64)
  Value that uniquely identifies the new plan that the duplication process creates.
• NewPlanIdSecondary: integer (int64)
  Value that uniquely identifies the new plan that the duplication process creates.
• NotesCount: integer
  Title: Notes

  Read Only: true

  Number of notes associated with this component item.
• OperationSequenceNumber: integer
  Title: Operation Sequence Number

  Read Only: true

  Order in which the operation occurs.
• Organization: string
  Read Only: true

  Maximum Length: 255

  Name of the organization.
• OrganizationCode: string
  Title: Organization

  Maximum Length: 49

  Organization code for the assembly item.
• OrganizationId: integer
  Unique identifier of the organization.
• OrganizationIdSecondary: integer
  Unique identifier of the organization.
• PlanId: integer
  Value that uniquely identifies the supply plan associated with the component item
• PlanIdSecondary: integer
  Value that uniquely identifies the supply plan associated with the component item
• PlanningPercentage: number
  Title: Planning Percentage

  Planning factor for this component as a percentage.
• Primary: string
  Title: Primary

  Read Only: true

  Maximum Length: 80

  Indicates if the component item is the primary item structure.
• SimulationSetId: integer (int64)
  Value that uniquely identifies the simulation set.
• SimulationSetIdSecondary: integer (int64)
  Value that uniquely identifies the simulation set.
• SubstituteItems: array Substitute Items
  Title: Substitute Items

  Component items substitutes that are part of the item structures of a supply plan.
• SupplyType: string
  Title: Supply Type

  Maximum Length: 4000

  Value that indicates the supply type for components. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.
• WorkDefinitionName: string
  Title: Work Definition

  Maximum Length: 300

  Name of the work definition associated with this item structure.

{
    "type":"object",
    "properties":{
        "ComponentItem":{
            "title":"Component Item",
            "maxLength":250,
            "type":"string",
            "description":"Name of the component item being consumed.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "ComponentItemUOM":{
            "title":"Component UOM",
            "maxLength":400,
            "type":"string",
            "description":"Unit of measure of the component item.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "type":"integer",
            "description":"Unique identifier of the component item.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyQuantity":{
            "title":"Assembly Quantity",
            "type":"number",
            "description":"Quantity of the assembly item.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "WorkDefinitionName":{
            "title":"Work Definition",
            "maxLength":300,
            "type":"string",
            "description":"Name of the work definition associated with this item structure.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ComponentItemUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code of the component item.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "NewPlanIdSecondary":{
            "type":"integer",
            "description":"Value that uniquely identifies the new plan that the duplication process creates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "Basis":{
            "title":"Basis",
            "maxLength":80,
            "type":"string",
            "description":"Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemEffectiveStartDate":{
            "title":"Component Item Effective Start Date",
            "type":"string",
            "description":"End date of effectivity for this component.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AssemblyItemUOMCode":{
            "title":"Assembly Item UOM",
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code of the assembly item.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AssemblyItemId":{
            "type":"integer",
            "description":"Unique identifier of the assembly item.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SimulationSetIdSecondary":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssemblyItem":{
            "title":"Assembly Item",
            "maxLength":250,
            "type":"string",
            "description":"Name of the assembly item.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"integer",
            "description":"Number used to locate a specific instance of an item in a structure. This number enables users to define multiple occurrences of the same component for an assembly in its item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "Primary":{
            "title":"Primary",
            "maxLength":80,
            "type":"string",
            "description":"Indicates if the component item is the primary item structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":49,
            "type":"string",
            "description":"Organization code for the assembly item.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "SupplyType":{
            "title":"Supply Type",
            "maxLength":4000,
            "type":"string",
            "description":"Value that indicates the supply type for components. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentItemDescription":{
            "title":"Component Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the component item being consumed.",
            "nullable":true,
            "x-queryable":true
        },
        "NewPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new plan that the duplication process creates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sequence in which a component is used within an operation.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the component item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemSequence":{
            "title":"Item Sequence",
            "type":"integer",
            "description":"Number that indicates the sequence for a component item for a work order operation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "NotesCount":{
            "title":"Notes",
            "type":"integer",
            "description":"Number of notes associated with this component item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationIdSecondary":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply plan associated with the component item",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PlanningPercentage":{
            "title":"Planning Percentage",
            "type":"number",
            "description":"Planning factor for this component as a percentage.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ComponentItemEffectiveEndDate":{
            "title":"Component Item Effective End Date",
            "type":"string",
            "description":"Start date of effectivity for this component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ChangeIndicatorFlag":{
            "type":"boolean",
            "description":"Value that identifies whether the component item has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentYield":{
            "title":"Component Yield",
            "type":"number",
            "description":"Factor used to multiply component quantity with to obtain the total quantity used of a component that actually becomes part of an assembly.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PlanIdSecondary":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply plan associated with the component item",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component on the source application instance.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BillSequenceIdSecondary":{
            "type":"integer",
            "description":"Value that uniquely identifies the sequence in which a component is used within an operation.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubstituteItems":{
            "title":"Substitute Items",
            "type":"array",
            "description":"Component items substitutes that are part of the item structures of a supply plan.",
            "items":{
                "$ref":"#/components/schemas/simulationSets-ComponentItems-SubstituteItems-item-response"
            }
        },
        "EnforceIntegerRequirement":{
            "title":"Enforce Integer Requirement",
            "maxLength":80,
            "type":"string",
            "description":"Specifies whether the result of a component's calculated quantity or inverse quantity is required to be an integer. Valid values for this option are None, Round up, and Round down.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentUsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"Quantity of the component to build one unit of item based on the component's primary UOM.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ItemStructureName":{
            "title":"Item Structure Name",
            "maxLength":80,
            "type":"string",
            "description":"Name for the categorization of an item structure, such as a design structure or manufacturing bill of material, that controls the usage and behavior of the structure.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AssemblyItemUOM":{
            "title":"Assembly Item UOM",
            "maxLength":400,
            "type":"string",
            "description":"Unit of measure of the assembly item.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence Number",
            "type":"integer",
            "description":"Order in which the operation occurs.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssemblyItemDescription":{
            "title":"Assembly Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the assembly item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the component item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : Substitute Items

Type: array

Title: Substitute Items

Component items substitutes that are part of the item structures of a supply plan.

Show Source

• Array of: object simulationSets-ComponentItems-SubstituteItems-item-response

{
    "title":"Substitute Items",
    "type":"array",
    "description":"Component items substitutes that are part of the item structures of a supply plan.",
    "items":{
        "$ref":"#/components/schemas/simulationSets-ComponentItems-SubstituteItems-item-response"
    }
}

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 : simulationSets-ComponentItems-SubstituteItems-item-response

Type: object

Show Source

• AssemblyItem: string
  Title: Assembly Item

  Read Only: true

  Name of the assembly item.
• AssemblyItemId: string
  Read Only: true

  Unique identifier of the assembly item.
• BillSequenceId: integer (int64)
  Value that uniquely identifies the sequence in which a component is used within an operation.
• ChangeIndicatorFlag: boolean
  Read Only: true

  Value that identifies whether the substitute component has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.
• ComponentItem: string
  Title: Component Item

  Read Only: true

  Name of the component item being consumed.
• ComponentItemId: string
  Read Only: true

  Unique identifier of the component item.
• ComponentSequenceId: integer (int64)
  Value that uniquely identifies the component on the source application instance.
• EnforceIntegerRequirement: string
  Title: Enforce Integer Requirement

  Read Only: true

  Maximum Length: 80

  Specifies whether the result of a component's calculated quantity or inverse quantity is required to be an integer. Valid values for this option are None, Round up, and Round down.
• FindNumber: string
  Title: Find Number

  Read Only: true

  Number used to locate a specific instance of an item in a structure. This number enables users to define multiple occurrences of the same component for an assembly in its item structure.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the component item was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the component item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewPlanId: integer
  Value that uniquely identifies the new plan that the duplication process creates.
• OperationSequenceNumber: string
  Title: Operation Sequence Number

  Read Only: true

  Order in which the operation occurs.
• Organization: string
  Read Only: true

  Name of the organization.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Organization code for the assembly item.
• OrganizationId: integer (int64)
  Unique identifier of the organization.
• PlanId: integer
  Value that uniquely identifies the supply plan associated with the component item
• SimulationSetId: integer
  Value that uniquely identifies the simulation set.
• SubstituteComponent: string
  Title: Substitute Component

  Maximum Length: 250

  Name of the substitute component.
• SubstituteComponentDescription: string
  Title: Substitute Component Description

  Maximum Length: 240

  Description of the substitute component.
• SubstituteComponentId: integer (int64)
  Unique identifier of the substitute component item.
• SubstituteComponentPriority: integer
  Title: Substitute Component Priority

  A numeric value indicating the priority of the object.
• SubstituteComponentQuantity: number
  Title: Substitute Component Quantity

  Quantity needed when using a substitute item in place of the original component item.
• SubstituteComponentUOM: string
  Title: Substitute Component UOM

  Maximum Length: 4000

  Unit of measure of the substitute component item.
• SubstituteComponentUOMCode: string
  Maximum Length: 3

  Unit of measure code of the substitute component item.
• SubstituteSequenceId: integer
  Value that uniquely identifies the substitute component on the source application instance.

{
    "type":"object",
    "properties":{
        "ComponentItem":{
            "title":"Component Item",
            "type":"string",
            "description":"Name of the component item being consumed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "type":"string",
            "description":"Unique identifier of the component item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentPriority":{
            "title":"Substitute Component Priority",
            "type":"integer",
            "description":"A numeric value indicating the priority of the object.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubstituteComponentUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code of the substitute component item.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubstituteComponentQuantity":{
            "title":"Substitute Component Quantity",
            "type":"number",
            "description":"Quantity needed when using a substitute item in place of the original component item.",
            "nullable":true,
            "x-queryable":true
        },
        "AssemblyItemId":{
            "type":"string",
            "description":"Unique identifier of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentUOM":{
            "title":"Substitute Component UOM",
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure of the substitute component item.",
            "nullable":true,
            "x-queryable":true
        },
        "AssemblyItem":{
            "title":"Assembly Item",
            "type":"string",
            "description":"Name of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"string",
            "description":"Number used to locate a specific instance of an item in a structure. This number enables users to define multiple occurrences of the same component for an assembly in its item structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "type":"string",
            "description":"Organization code for the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NewPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new plan that the duplication process creates.",
            "nullable":false,
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sequence in which a component is used within an operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Unique identifier of the substitute component item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the component item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponent":{
            "title":"Substitute Component",
            "maxLength":250,
            "type":"string",
            "description":"Name of the substitute component.",
            "nullable":true,
            "x-queryable":true
        },
        "SubstituteSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute component on the source application instance.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply plan associated with the component item",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeIndicatorFlag":{
            "type":"boolean",
            "description":"Value that identifies whether the substitute component has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component on the source application instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnforceIntegerRequirement":{
            "title":"Enforce Integer Requirement",
            "maxLength":80,
            "type":"string",
            "description":"Specifies whether the result of a component's calculated quantity or inverse quantity is required to be an integer. Valid values for this option are None, Round up, and Round down.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence Number",
            "type":"string",
            "description":"Order in which the operation occurs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteComponentDescription":{
            "title":"Substitute Component Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the substitute component.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the component item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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