Jump to

• Request
• Response

Get one item that uses this component

get

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

Request

Path Parameters

• BillSequenceId(required): integer
  Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
• ComponentSequenceId(required): number
  Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
• WhereUsedUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Where Used for Item Structures resource and used to uniquely identify an instance of Where Used for Item Structures. The client should not generate the hash key value. Instead, the client should query on the Where Used for Item Structures collection resource in order to navigate to a specific instance of Where Used for Item Structures to get the hash key.

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

Type: object

Show Source

• BasisValue: string
  Maximum Length: 80

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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