Get all components

get

/crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}/child/Component

Request

Path Parameters
  • The unique identifier of the bill sequence. A value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 a component with the specified primary key.
      Finder Variables:
      • ComponentSequenceId; integer; The unique identifier of the component.
    • getComponentByItemNumber: Finds a component with specified structure item number and component item number.
      Finder Variables:
      • ComponentItemNumber; string; The component item number that identifies a part, material, product, or service.
      • ComponentOrganizationCode; string; The component organization code that identifies the name of an organizing unit in the internal or external organization structure of your enterprise.
      • StructureItemNumber; string; The structure item number that identifies a part, material, product, or service.
      • StructureOrganizationCode; string; The structure organization code that identifies the name of an organizing unit in the internal or external organization structure of your enterprise.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • BOMItemType; number; The type of bill of material associated with the cpomponent such as standard, model, planning, and other.
    • BillSequenceId; integer; Value that uniquely identifies the bill of material. This is the foreign key to the Structure view object. This attribute is read-only, and can be modified only if the resource is already modified.
    • Comments; string; An attribute value that represents comments about a component.
    • ComponentItemDescription; string; The description of the item associated with the component.
    • ComponentItemId; string; Value that uniquely identifies the item associated with the component.
    • ComponentItemName; string; The name of the item associated with the component.
    • 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.
    • ComponentOrganizationCode; string; Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
    • ComponentSequenceId; integer; Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
    • ComponentStructureItemTypeValue; string; Value that identifies whether the component sub-assembly is date effective or is model or unit effective.
    • CreatedBy; string; The user who created the component.
    • CreationDateTime; string; The date and time when the structure was created.
    • CustomerOrderEnabledFlag; boolean; Indicates whether the custom order is enabled. The values are true and false. If true, then the item can be ordered by external customers at this point of time. If false, then the item can't be ordered by external customers at this point of time. The default value is false. For a list of attribute value interdependencies, refer to Interdependent Item Attributes in Using Product Master Data Management Guide.
    • EndDateTime; string; The date and time when a component in a structure ends.
    • ImplementationDateTime; string; 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. This is read only attribute.
    • ItemSequenceNumber; number; A unique number which defines the sequence of components in a structure.
    • LastUpdateDateTime; string; The date and time when the structure was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the component.
    • LastUpdatedBy; string; The user who last updated the component.
    • 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; Indicates whether one or more options under this Option Class can be chosen.
    • OptionalFlag; boolean; Indicates whether the component is optional for a structure.
    • OrganizationId; string; Value that uniquely identifies the organization.
    • PrimaryUOMCode; string; Primary unit of measure for the item quantities.
    • Quantity; number; An attribute value the represents the quantity of component item used.
    • SoBasis; number; Value that indicates the basis to override the default quantity for the option class when a sales order is entered (the default), for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.
    • StartDateTime; string; The date and time when a component in a structure begins.
    • StructureItemNumber; string; Number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
    • StructureOrganizationCode; string; Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
    • WIPSupplyType; integer; Type of supply for components.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : productStructures-Component
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : productStructures-Component-item-response
Type: object
Show Source
  • Title: Bill Sequence Id
    Value that uniquely identifies the bill of material. This is the foreign key to the Structure view object. This attribute is read-only, and can be modified only if the resource is already modified.
  • Title: Structure Item Type
    The type of bill of material associated with the cpomponent such as standard, model, planning, and other.
  • Title: Comments
    Maximum Length: 240
    An attribute value that represents comments about a component.
  • Title: Description
    Read Only: true
    Maximum Length: 255
    The description of the item associated with the component.
  • Title: Inventory Item ID
    Maximum Length: 240
    Value that uniquely identifies the item associated with the component.
  • Title: Product
    Read Only: true
    Maximum Length: 255
    The name of the item associated with the component.
  • Title: Component Product Number
    An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.
  • Title: Component Organization Code
    Maximum Length: 255
    Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
  • Title: Component Sequence Id
    Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
  • Title: Component Structure Item Type Value
    Maximum Length: 255
    Value that identifies whether the component sub-assembly is date effective or is model or unit effective.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the component.
  • Title: Creation Date
    Read Only: true
    The date and time when the structure was created.
  • Title: Customer Order Enabled
    Maximum Length: 1
    Indicates whether the custom order is enabled. The values are true and false. If true, then the item can be ordered by external customers at this point of time. If false, then the item can't be ordered by external customers at this point of time. The default value is false. For a list of attribute value interdependencies, refer to Interdependent Item Attributes in Using Product Master Data Management Guide.
  • Title: End Date Time
    The date and time when a component in a structure ends.
  • Title: Implementation Date Time
    Read Only: true
    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. This is read only attribute.
  • Title: Item Sequence
    A unique number which defines the sequence of components in a structure.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the structure was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the component.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the component.
  • Links
  • Title: Maximum Quantity
    An attribute that value indicates the maximum quantity allowed on an order.
  • Title: Minimum Quantity
    An attribute that value indicates the minimum quantity allowed on an order.
  • Title: Mutually Exclusive
    Default Value: false
    Indicates whether one or more options under this Option Class can be chosen.
  • Title: Required
    Default Value: false
    Indicates whether the component is optional for a structure.
  • Title: Component Organization ID
    Maximum Length: 240
    Value that uniquely identifies the organization.
  • Title: Primary Unit of Measure
    Maximum Length: 30
    Primary unit of measure for the item quantities.
  • Title: Quantity
    Default Value: 1
    An attribute value the represents the quantity of component item used.
  • Title: Quantity Editable
    Default Value: 2
    Value that indicates the basis to override the default quantity for the option class when a sales order is entered (the default), for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.
  • Title: Start Date Time
    The date and time when a component in a structure begins.
  • Title: Structure Product Number
    Maximum Length: 255
    Number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
  • Title: Structure Organization Code
    Maximum Length: 255
    Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
  • Title: Supply Type
    Type of supply for components.
Back to Top