Jump to

• Request
• Response

Get one component

get

/fscmRestApi/resources/11.13.18.05/configuredItems/{LineExplId}/child/components/{LineExplId2}/child/components/{LineExplId3}

Request

Path Parameters

• LineExplId(required): integer(int64)
  Value that uniquely identifies the generated configured item.
• LineExplId2(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=
• LineExplId3(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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

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(required):
  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(required):
  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 : configuredItems-components-components-item-response

Type: object

Show Source

• BasisType: integer
  Read Only: true

  Value that identifies the component usage as fixed or variable. Value is 1. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
• BasisTypeDescription: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the component usage as fixed or variable. Value for items is variable component usage. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
• BillSequenceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
• CheckATP: number
  Read Only: true

  Identifies whether availability to promise (ATP) should be checked for component. Valid values include 1: Material only, 2: Material and Resource, 3: None, or 4: Resource only. The value is retrieved from the model structure. A list of accepted values is defined in the lookup type EGP_ORDATPCHECKVS_TYPE.
• ComponentHierarchy: string
  Maximum Length: 4000

  Hierarchy of the component. The unique identifiers of the value are separated by the delimiter -.
• ComponentItemHierarchy: string
  Maximum Length: 4000

  Hierarchy of inventory item. The unique identifiers of the value are separated by the delimiter -.
• ComponentSequenceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the component sequence for the selected component. This is defined in the base model item structure.
• ComponentType: number
  Read Only: true

  Value that identifies the item as a component of a model. Value is 1.
• ComponentYieldFactor: number
  Read Only: true

  Factor used to multiply with the component quantity to obtain component quantity. This is retrieved from the model structure.
• ConfigItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item being assembled.
• DateCreated: string (date)
  Read Only: true

  Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
• DateDisabled: string (date)
  Read Only: true

  Date when the item or component is disabled.
• EffectivityDate: string (date)
  Read Only: true

  Date when the item or component is effective.
• HeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the match header.
• InventoryItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the line item.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory item for the line item.
• InventoryItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the line item.
• ItemClassId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item class of the configured item component.
• ItemClassName: string
  Read Only: true

  Maximum Length: 80

  Name of the item class of the configured item component.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  Revision of the item.
• LineExplId: integer (int64)
  Read Only: true

  Value that uniquely identifies the generated component item.
• LineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the match detail record entry.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptionalComponent: string
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the component is optional. If N, then the component is mandatory. The default value is N.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization of the inventory item.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization of the inventory item.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory item organization.
• ParentInventoryItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item in the parent inventory.
• ParentInventoryItemId: integer
  Read Only: true

  Value that uniquely identifies the item in the parent inventory.
• ParentInventoryItemNumber: string
  Read Only: true

  Maximum Length: 300

  Name of the item in the parent inventory.
• ParentLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the line representing the immediate parent item for the component.
• PlanningFactor: number
  Read Only: true

  Factor used to multiply with the component quantity to obtain planning quantity.
• RevisionId: integer
  Read Only: true

  Value that uniquely identifies the item revision.
• RootPhantomItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of phantom subassembly item.
• RootPhantomItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the phantom subassembly item.
• RootPhantomItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the phantom subassembly item.
• RoundingDirection: number
  Read Only: true

  Rounding direction. Values include up or down. This is retrieved from the model structure.
• SubItemType: integer (int64)
  Read Only: true

  Value that identifies the type of structure. Valid values are 1, 2, or 4. The default value is 4. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.
• SubItemTypeName: string
  Read Only: true

  Maximum Length: 80

  Name of the type of structure. Valid values are Model, Option Class, or Standard. The default value is Standard. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
• UnitQuantity: number
  Read Only: true

  Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
• UnitUOM: string
  Read Only: true

  Maximum Length: 3

  Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
• WIPSupplyType: integer
  Read Only: true

  Value that identifies the type of supply that is work in progress. Values are 1, 2, 3, 4, 5, and 6. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.
• WIPSupplyTypeName: string
  Read Only: true

  Maximum Length: 80

  Name of the work in progress supply type of the component. Values are Assembly pull, Bulk, Operation pull, Phantom, Push, and Supplier. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.

{
    "type":"object",
    "properties":{
        "ParentInventoryItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item in the parent inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory item organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoundingDirection":{
            "type":"number",
            "description":"Rounding direction. Values include up or down. This is retrieved from the model structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WIPSupplyTypeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the work in progress supply type of the component. Values are Assembly pull, Bulk, Operation pull, Phantom, Push, and Supplier. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemClassName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the item class of the configured item component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line representing the immediate parent item for the component.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RootPhantomItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the phantom subassembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the match header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DateCreated":{
            "type":"string",
            "description":"Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningFactor":{
            "type":"number",
            "description":"Factor used to multiply with the component quantity to obtain planning quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfigItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item being assembled.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item revision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubItemTypeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of structure. Valid values are Model, Option Class, or Standard. The default value is Standard. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentInventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the parent inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectivityDate":{
            "type":"string",
            "description":"Date when the item or component is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentHierarchy":{
            "maxLength":4000,
            "type":"string",
            "description":"Hierarchy of the component. The unique identifiers of the value are separated by the delimiter -.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the inventory 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"
            }
        },
        "ComponentYieldFactor":{
            "type":"number",
            "description":"Factor used to multiply with the component quantity to obtain component quantity. This is retrieved from the model structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineExplId":{
            "type":"integer",
            "description":"Value that uniquely identifies the generated component item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubItemType":{
            "type":"integer",
            "description":"Value that identifies the type of structure. Valid values are 1, 2, or 4. The default value is 4. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckATP":{
            "type":"number",
            "description":"Identifies whether availability to promise (ATP) should be checked for component. Valid values include 1: Material only, 2: Material and Resource, 3: None, or 4: Resource only. The value is retrieved from the model structure. A list of accepted values is defined in the lookup type EGP_ORDATPCHECKVS_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentType":{
            "type":"number",
            "description":"Value that identifies the item as a component of a model. Value is 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the match detail record entry.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item for the line item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitQuantity":{
            "type":"number",
            "description":"Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component sequence for the selected component. This is defined in the base model item structure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WIPSupplyType":{
            "type":"integer",
            "description":"Value that identifies the type of supply that is work in progress. Values are 1, 2, 3, 4, 5, and 6. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootPhantomItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of phantom subassembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemHierarchy":{
            "maxLength":4000,
            "type":"string",
            "description":"Hierarchy of inventory item. The unique identifiers of the value are separated by the delimiter -.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalComponent":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the component is optional. If N, then the component is mandatory. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisType":{
            "type":"integer",
            "description":"Value that identifies the component usage as fixed or variable. Value is 1. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateDisabled":{
            "type":"string",
            "description":"Date when the item or component is disabled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item class of the configured item component.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RootPhantomItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the phantom subassembly item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BasisTypeDescription":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the component usage as fixed or variable. Value for items is variable component usage. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentInventoryItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item in the parent inventory.",
            "nullable":true,
            "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 : 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."
        }
    }
}

Back to Top