Jump to

• Request
• Response

Get

get

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

Request

Path Parameters

• BillSequenceId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• ComponentSequenceId(required): number
  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=
• WhereUsedUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the (WhereUsed) resource and used to uniquely identify an instance of (WhereUsed). The client should not generate the hash key value. Instead, the client should query on the (WhereUsed) collection resource in order to navigate to a specific instance of (WhereUsed) 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : itemStructures-Component-WhereUsed-item-response

Type: object

Show Source

• BasisValue: string
  Maximum Length: 80

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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