Jump to

• Request
• Response

Get all

get

/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Expansion

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=

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
    Finder Variables
    • ComponentSequencePath; string;
• 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:
  

  • ATPCode; string; An attribute to check the following information when placing a demand: available to promise and capable to promise.
  • ATPComponentFlag; boolean; A flag that indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
  • ATPComponentsCode; string; An attribute indicating whether to check additional components in the bill of material of assemble-to-order and pick-to-order items when running the available to promise checks.
  • ATPFlag; boolean; A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • AbsoluteYield; number; Absolute yield of a component. The value equals quantity times yield.
  • AutoRequestMaterialFlag; boolean; A flag that indicates if a move order is automatically created for a material at work order release.
  • BasisType; number
  • BasisValue; string; An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
  • CheckATPFlag; boolean; A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Comments; string; An attribute value that represents comments about a component.
  • CommonComponentSequenceId; number; A unique identifier for an component in a structure.
  • CompAlternateBomDesignator; string; Indicates the context formula for an ingredient.
  • CompletionType; string; Indicates how the output item will be reported during work execution.
  • CompletionTypeValue; string; Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None.
  • ComponentItemId; string; A unique value that identifies the item of a component.
  • ComponentItemNumber; string; An attribute value that represents the item number of a component.
  • ComponentPath; string; An attribute value that represents the hierarchical Path of a component item to the root item in a structure.
  • ComponentSequenceId; number; A unique identifier for an Component in a structure.
  • ComponentSequencePath; string; An attribute value that represents the hierarchical Path or linage of a component item to the root item in a structure using the component sequence IDs.
  • ComponentStructureItemTypeValue; string; An attribute which indicates the component sub-assembly is Date effective or "Model or Unit" effetive.
  • ComponentType; string; Indicates the type of material for the formula.
  • ComponentTypeValue; string; Indicates the type of material. The values include Ingredient or Product.
  • ComponentUOMCodeValue; string; A value which indicates the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table.
  • ContributeToYield; string; Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.
  • ContributeToYieldValue; string; Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
  • CustomerOrderEnabledFlag; boolean; A flag indicating whether an item is currently customer orderable.
  • CustomerOrderFlag; boolean; A flag attribute Indicating whether to allow an item to be ordered by external customers.
  • EndDateTime; string; The date and time on which a component in a structure ends.
  • EnforceIntRequirements; number
  • EnforceIntegerRequirementsValue; string; Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit/serial effective structures.
  • ExpandModelFlag; boolean
  • ExpandOption; integer
  • ExpansionDateTime; string
  • ExpansionType; integer
  • ExtendedQuantity; number; A calculated total quantity of the component used in the whole explosion.
  • FindNumber; integer; An attribute value that holds find number for the component.
  • FromNumber; string; The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • FromSerialNumber; string
  • FromUnitNumber; string
  • ImplementationDate; string; A date on which the item revision is schedule to be implemented.
  • ImplementationOnlyFlag; boolean
  • IncludeOnShipDocsFlag; boolean; A flag value that indicates if a component is displayed on shipping documentation.
  • InstantiabilityCode; string
  • InstantiabilityValue; string; A unique identifier indicating whether a component item is instantiable in an item structure.
  • InternalOrderEnabledFlag; boolean; A flag indicating whether to allow an item to be ordered on an internal requisition.
  • InternalOrderFlag; boolean; Attribute indicating whether an Item can be ordered internally.
  • InverseQuantity; number; An attribute value which represents the inverse of an exact or specified quantity defined for a structure component.
  • ItemClassName; string; An attribute value that provides metadata common to all items that share the category.
  • ItemSequenceNumber; number; A unique number which defines the sequence of components in a structure.
  • ItemStatus; string; 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.
  • 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; A flag indicating if one or more options under this Option Class can be chosen.
  • OptionalFlag; boolean; A flag indicating if component is optional for a structure.
  • OrganizationCode; string; The parent 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.
  • OrganizationId; string; The unique identifier 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; A unique identifier for parent structure.
  • ParentCommonBillSequenceId; integer; A unique identifier for parent structure.
  • ParentComponentSequencePath; string; An attribute value that represents the hierarchical Path or linage of a parent component item to the root item in a structure using the component sequence IDs.
  • ParentEffectivityControl; number
  • ParentEffectivityControlValue; string; An attribute which value indicates the way effectively is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
  • ParentItemId; string; A unique value 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.
  • 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.
  • ParentStructureDescription; string; An attribute which value represents the description of a parent structure.
  • ParentStructureItemTypeValue; string; An attribute which indicates the structure is Date effective or "Model or Unit" effetive.
  • ParentStructureName; string; An attribute which value represents the name of a parent structure.
  • PercentBatch; number; Indicates the percentage of each ingredient or component relative to the total weight or volume of a specific batch of the formula.
  • PercentFormula; number; Indicates the usable percentage of a formula after processing, accounting for waste.
  • PickComponentFlag; boolean; A flag indicating whether an item has a structure l with options, classes, or included items picked from finished goods inventory.
  • PlanLevel; number; An attribute which indicates the depth of the node (row) in the exploded tree. For example, a value 0 denotes that it is the root node.
  • PlanningPercentage; number; An attribute used by forecast planning that represents the distribution percentage for a component.
  • PrimaryUOMValue; string
  • PrimaryUomCode; string
  • ProductType; string; Type of product for the formula output.
  • ProductTypeValue; string; Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
  • Quantity; number; An attribute value the represents the quantity of component item used.
  • QuantityRelatedFlag; boolean; An attribute that Identifiers to indicates if this component has quantity related reference designators.
  • ReplenishToOrderFlag; boolean; A flag indicating is generally built for sales order demand; a final assembly work order is created based on sales order details.
  • RequiredForRevenueFlag; boolean; A flag indicating if component is required to recognize revenue before you ship the order.
  • RequiredToShipFlag; boolean; A flag indicating if component is required to ship the order.
  • SalesOrderBasisValue; string; An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
  • SalesOrderTransactionFlag; boolean; A flag that is a reference to the source transaction definition that identifies the type of transactions within each application where a budgetary control transaction is originated.
  • ShippableItemFlag; boolean; A flag indicating whether to ship an item to a customer.
  • ShowInSales; number
  • ShowInSalesValue; string; An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
  • SoBasis; number
  • StartDateTime; string; The date and time on which a component in a structure begins.
  • SuggestedOperationSequence; integer; An attribute value that holds the suggested operation sequence.
  • SupplyType; string; An attribute indicating a supply type for components.
  • ToNumber; string; The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • TopBillSequenceId; string; A unique identifier for the bill sequence of the root item of the structure.
  • TopItemId; string; A unique identifier for the root item for the explosion of the structure.
  • TopItemNumber; string; An attribute value that is the identifier for the root item for the explosion of the structure.
  • UsePlaceholderFlag; boolean; An attribute that determines whether option class item data should be loaded into configurator models or not.
  • UserItemTypeValue; string; A unique value 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.
  • WipSupplyType; number
  • Yield; number; An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.
• 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 : itemStructures-Expansion

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object itemStructures-Expansion-item-response

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

Type: object

Show Source

• AbsoluteYield: number
  Absolute yield of a component. The value equals quantity times yield.
• ATPCode: string
  Read Only: true

  An attribute to check the following information when placing a demand: available to promise and capable to promise.
• ATPComponentFlag: boolean
  Title: Available to Promise

  Maximum Length: 1

  A flag that indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
• ATPComponentsCode: string
  Read Only: true

  An attribute indicating whether to check additional components in the bill of material of assemble-to-order and pick-to-order items when running the available to promise checks.
• ATPFlag: boolean
  Title: Available to Promise

  Maximum Length: 1

  A flag indicating to check available to promise and/or capable to promise information when placing demand.
• AutoRequestMaterialFlag: boolean
  Title: Automatically Request Material

  Maximum Length: 1

  A flag that indicates if a move order is automatically created for a material at work order release.
• BasisType: number
  Title: Basis
• BasisValue: string
  An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
• CheckATPFlag: boolean
  Title: Check ATP

  A flag indicating to check available to promise and/or capable to promise information when placing demand.
• Comments: string
  Title: Comments

  Maximum Length: 240

  An attribute value that represents comments about a component.
• CommonComponentSequenceId: number
  A unique identifier for an component in a structure.
• CompAlternateBomDesignator: string
  Maximum Length: 80

  Indicates the context formula for an ingredient.
• CompletionType: string
  Maximum Length: 30

  Indicates how the output item will be reported during work execution.
• CompletionTypeValue: string
  Read Only: true

  Maximum Length: 255

  Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None.
• ComponentItemId: string
  Maximum Length: 240

  A unique value that identifies the item of a component.
• ComponentItemNumber: string
  Maximum Length: 40

  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: number
  A unique identifier for an Component in a structure.
• ComponentSequencePath: string
  Title: Path

  Maximum Length: 32767

  An attribute value that represents the hierarchical Path or linage of a component item to the root item in a structure using the component sequence IDs.
• ComponentStructureItemTypeValue: string
  An attribute which indicates the component sub-assembly is Date effective or "Model or Unit" effetive.
• ComponentType: string
  Maximum Length: 30

  Indicates the type of material for the formula.
• ComponentTypeValue: string
  Read Only: true

  Maximum Length: 255

  Indicates the type of material. The values include Ingredient or Product.
• ComponentUOMCodeValue: string
  Maximum Length: 255

  A value which indicates the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table.
• ContributeToYield: string
  Maximum Length: 30

  Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.
• ContributeToYieldValue: string
  Read Only: true

  Maximum Length: 255

  Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
• CustomerOrderEnabledFlag: boolean
  Title: Customer Orders Enabled

  Maximum Length: 1

  A flag indicating whether an item is currently customer orderable.
• CustomerOrderFlag: boolean
  Title: Customer Ordered

  Maximum Length: 1

  A flag attribute Indicating whether to allow an item to be ordered by external customers.
• EndDateTime: string (date)
  Title: End Date

  The date and time on which a component in a structure ends.
• EnforceIntegerRequirementsValue: string
  Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit/serial effective structures.
• EnforceIntRequirements: number
  Title: Enforce Integer Requirement
• ExpandModelFlag: boolean
  Read Only: true
• ExpandOption: integer
  Read Only: true
• ExpansionDateTime: string (date-time)
  Read Only: true
• ExpansionType: integer
  Read Only: true
• ExtendedQuantity: number
  A calculated total quantity of the component used in the whole explosion.
• FindNumber: integer
  Title: Find Number

  Read Only: true

  An attribute value that holds find number for the component.
• FromNumber: string
  Title: From End Item Unit Number

  Maximum Length: 30

  The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
• FromSerialNumber: string
  Read Only: true

  Maximum Length: 30
• FromUnitNumber: string
  Read Only: true

  Maximum Length: 30
• ImplementationDate: string (date)
  Title: Effective Date

  A date on which the item revision is schedule to be implemented.
• ImplementationOnlyFlag: boolean
  Read Only: true
• IncludeOnShipDocsFlag: boolean
  Title: Include on Shipping Documents

  A flag value that indicates if a component is displayed on shipping documentation.
• InstantiabilityCode: string
  Maximum Length: 30
• InstantiabilityValue: string
  A unique identifier indicating whether a component item is instantiable in an item structure.
• InternalOrderEnabledFlag: boolean
  Title: Transfer Orders Enabled

  Maximum Length: 1

  A flag indicating whether to allow an item to be ordered on an internal requisition.
• InternalOrderFlag: boolean
  Title: Internally Transferable

  Maximum Length: 1

  Attribute indicating whether an Item can be ordered internally.
• InverseQuantity: number
  An attribute value which represents the inverse of an exact or specified quantity defined for a structure component.
• ItemClassName: string
  An attribute value that provides metadata common to all items that share the category.
• ItemSequenceNumber: number
  Title: Item Sequence

  A unique number which defines the sequence of components in a structure.
• ItemStatus: string
  Maximum Length: 30

  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumQuantity: number
  Title: Maximum Quantity

  An attribute that value indicates the maximum quantity allowed on an order.
• MinimumQuantity: number
  Title: Minimum Quantity

  An attribute that value indicates the minimum quantity allowed on an order.
• MutuallyExclusiveFlag: boolean
  Title: Mutually Exclusive

  A flag indicating if one or more options under this Option Class can be chosen.
• OptionalFlag: boolean
  Title: Optional

  A flag indicating if component is optional for a structure.
• OrganizationCode: string
  The parent 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.
• OrganizationId: string
  Maximum Length: 240

  The unique identifier 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.
• ParentCommonBillSequenceId: integer (int64)
  A unique identifier for parent structure.
• ParentComponentSequencePath: string
  Maximum Length: 32767

  An attribute value that represents the hierarchical Path or linage of a parent component item to the root item in a structure using the component sequence IDs.
• ParentEffectivityControl: number
• ParentEffectivityControlValue: string
  An attribute which value indicates the way effectively is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
• ParentItemId: string
  Maximum Length: 240

  A unique value 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.
• 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.
• ParentStructureDescription: string
  Title: Description

  Maximum Length: 240

  An attribute which value represents the description of a parent structure.
• ParentStructureItemTypeValue: string
  An attribute which indicates the structure is Date effective or "Model or Unit" effetive.
• ParentStructureName: string
  Maximum Length: 255

  An attribute which value represents the name of a parent structure.
• PercentBatch: number
  Indicates the percentage of each ingredient or component relative to the total weight or volume of a specific batch of the formula.
• PercentFormula: number
  Indicates the usable percentage of a formula after processing, accounting for waste.
• PickComponentFlag: boolean
  Title: Pick Components

  A flag indicating whether an item has a structure l with options, classes, or included items picked from finished goods inventory.
• PlanLevel: number
  An attribute which indicates the depth of the node (row) in the exploded tree. For example, a value 0 denotes that it is the root node.
• PlanningPercentage: number
  Title: Planning Percent

  An attribute used by forecast planning that represents the distribution percentage for a component.
• PrimaryUomCode: string
  Maximum Length: 3
• PrimaryUOMValue: string
  Maximum Length: 255
• ProductType: string
  Maximum Length: 30

  Type of product for the formula output.
• ProductTypeValue: string
  Read Only: true

  Maximum Length: 255

  Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
• Quantity: number
  Title: Quantity

  An attribute value the represents the quantity of component item used.
• QuantityRelatedFlag: boolean
  Title: Quantity Related

  An attribute that Identifiers to indicates if this component has quantity related reference designators.
• ReplenishToOrderFlag: boolean
  Title: Assemble to Order

  Maximum Length: 1

  A flag indicating is generally built for sales order demand; a final assembly work order is created based on sales order details.
• RequiredForRevenueFlag: boolean
  Title: Required for Revenue

  A flag indicating if component is required to recognize revenue before you ship the order.
• RequiredToShipFlag: boolean
  Title: Required to Ship

  A flag indicating if component is required to ship the order.
• SalesOrderBasisValue: string
  An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
• SalesOrderTransactionFlag: boolean
  Maximum Length: 1

  A flag that is a reference to the source transaction definition that identifies the type of transactions within each application where a budgetary control transaction is originated.
• ShippableItemFlag: boolean
  Title: Shippable

  Maximum Length: 1

  A flag indicating whether to ship an item to a customer.
• ShowInSales: number
• ShowInSalesValue: string
  An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
• SoBasis: number
  Title: Sales Order Basis
• StartDateTime: string (date)
  Title: Start Date

  The date and time on which a component in a structure begins.
• SuggestedOperationSequence: integer
  Title: Suggested Operation Sequence

  Read Only: true

  An attribute value that holds the suggested operation sequence.
• SupplyType: string
  An attribute indicating a supply type for components.
• ToNumber: string
  Title: To End Item Unit Number

  Maximum Length: 30

  The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
• TopBillSequenceId: string
  Maximum Length: 256

  A unique identifier for the bill sequence of the root item of the structure.
• TopItemId: string
  Maximum Length: 256

  A unique identifier for the root item for the explosion of the structure.
• TopItemNumber: string
  An attribute value that is the identifier for the root item for the explosion of the structure.
• UsePlaceholderFlag: boolean
  An attribute that determines whether option class item data should be loaded into configurator models or not.
• UserItemTypeValue: string
  Maximum Length: 255

  A unique value 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.
• WipSupplyType: number
  Title: Supply Type
• Yield: number
  Title: Yield

  An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.

{
    "type":"object",
    "properties":{
        "ATPCode":{
            "type":"string",
            "description":"An attribute to check the following information when placing a demand: available to promise and capable to promise.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ATPComponentFlag":{
            "title":"Available to Promise",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag that indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.",
            "nullable":true,
            "x-queryable":true
        },
        "ATPComponentsCode":{
            "type":"string",
            "description":"An attribute indicating whether to check additional components in the bill of material of assemble-to-order and pick-to-order items when running the available to promise checks.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ATPFlag":{
            "title":"Available to Promise",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag indicating to check available to promise and/or capable to promise information when placing demand.",
            "nullable":true,
            "x-queryable":true
        },
        "AbsoluteYield":{
            "type":"number",
            "description":"Absolute yield of a component. The value equals quantity times yield.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoRequestMaterialFlag":{
            "title":"Automatically Request Material",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag that indicates if a move order is automatically created for a material at work order release.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Basis",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "BasisValue":{
            "type":"string",
            "description":"An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)",
            "nullable":true,
            "x-queryable":true
        },
        "CheckATPFlag":{
            "title":"Check ATP",
            "type":"boolean",
            "description":"A flag indicating to check available to promise and/or capable to promise information when placing demand.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"An attribute value that represents comments about a component.",
            "nullable":true,
            "x-queryable":true
        },
        "CommonComponentSequenceId":{
            "type":"number",
            "description":"A unique identifier for an component in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "CompAlternateBomDesignator":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the context formula for an ingredient.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates how the output item will be reported during work execution.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "maxLength":240,
            "type":"string",
            "description":"A unique value that identifies the item of a component.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemNumber":{
            "maxLength":40,
            "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":"number",
            "description":"A unique identifier for an Component in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentSequencePath":{
            "title":"Path",
            "maxLength":32767,
            "type":"string",
            "description":"An attribute value that represents the hierarchical Path or linage of a component item to the root item in a structure using the component sequence IDs.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentStructureItemTypeValue":{
            "type":"string",
            "description":"An attribute which indicates the component sub-assembly is Date effective or \"Model or Unit\" effetive.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of material for the formula.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the type of material. The values include Ingredient or Product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentUOMCodeValue":{
            "maxLength":255,
            "type":"string",
            "description":"A value which indicates the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table.",
            "nullable":true,
            "x-queryable":true
        },
        "ContributeToYield":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.",
            "nullable":true,
            "x-queryable":true
        },
        "ContributeToYieldValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerOrderEnabledFlag":{
            "title":"Customer Orders Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag indicating whether an item is currently customer orderable.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerOrderFlag":{
            "title":"Customer Ordered",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag attribute Indicating whether to allow an item to be ordered by external customers.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time on which a component in a structure ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceIntRequirements":{
            "title":"Enforce Integer Requirement",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceIntegerRequirementsValue":{
            "type":"string",
            "description":"Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit/serial  effective structures.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpandModelFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpandOption":{
            "type":"integer",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpansionDateTime":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpansionType":{
            "type":"integer",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtendedQuantity":{
            "type":"number",
            "description":"A calculated total quantity of the component used in the whole explosion.",
            "nullable":true,
            "x-queryable":true
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"integer",
            "description":"An attribute value that holds find number for the component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromNumber":{
            "title":"From End Item Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The item unit number or serial number from which the component is effective. Valid only for unit or serial  effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "FromSerialNumber":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromUnitNumber":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementationDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"A date on which the item revision is schedule to be implemented.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementationOnlyFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeOnShipDocsFlag":{
            "title":"Include on Shipping Documents",
            "type":"boolean",
            "description":"A flag value that indicates if a component is displayed on shipping documentation.",
            "nullable":true,
            "x-queryable":true
        },
        "InstantiabilityCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "InstantiabilityValue":{
            "type":"string",
            "description":"A unique identifier indicating whether a component item is instantiable in an item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalOrderEnabledFlag":{
            "title":"Transfer Orders Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag indicating whether to allow an item to be ordered on an internal requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalOrderFlag":{
            "title":"Internally Transferable",
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute indicating whether an Item can be ordered internally.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseQuantity":{
            "type":"number",
            "description":"An attribute value which represents the inverse of an exact or specified quantity defined for a structure component.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemClassName":{
            "type":"string",
            "description":"An attribute value that provides metadata common to all items that share the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSequenceNumber":{
            "title":"Item Sequence",
            "type":"number",
            "description":"A unique number which defines the sequence of components in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemStatus":{
            "maxLength":30,
            "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
        },
        "MaximumQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"An attribute that value indicates the maximum quantity allowed on an order.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"An attribute that value indicates the minimum quantity allowed on an order.",
            "nullable":true,
            "x-queryable":true
        },
        "MutuallyExclusiveFlag":{
            "title":"Mutually Exclusive",
            "type":"boolean",
            "description":"A flag indicating if one or more options under this Option Class can be chosen.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalFlag":{
            "title":"Optional",
            "type":"boolean",
            "description":"A flag indicating if component is optional for a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"The parent  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
        },
        "OrganizationId":{
            "maxLength":240,
            "type":"string",
            "description":"The unique identifier 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
        },
        "ParentCommonBillSequenceId":{
            "type":"integer",
            "description":"A unique identifier for parent structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentComponentSequencePath":{
            "maxLength":32767,
            "type":"string",
            "description":"An attribute value that represents the hierarchical Path or linage of a parent component item to the root item in a structure using the component sequence IDs.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEffectivityControl":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEffectivityControlValue":{
            "type":"string",
            "description":"An attribute which value indicates the way effectively is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentItemId":{
            "maxLength":240,
            "type":"string",
            "description":"A unique value 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
        },
        "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
        },
        "ParentStructureDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"An attribute which value represents the description of a parent structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentStructureItemTypeValue":{
            "type":"string",
            "description":"An attribute which indicates the structure is Date effective or \"Model or Unit\" effetive.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentStructureName":{
            "maxLength":255,
            "type":"string",
            "description":"An attribute which value represents the name of a parent structure.",
            "nullable":true,
            "x-queryable":true
        },
        "PercentBatch":{
            "type":"number",
            "description":"Indicates the percentage of each ingredient or component relative to the total weight or volume of a specific batch of the formula.",
            "nullable":true,
            "x-queryable":true
        },
        "PercentFormula":{
            "type":"number",
            "description":"Indicates the usable percentage of a formula after processing, accounting for waste.",
            "nullable":true,
            "x-queryable":true
        },
        "PickComponentFlag":{
            "title":"Pick Components",
            "type":"boolean",
            "description":"A flag indicating whether an item has a structure l with options, classes, or included items picked from finished goods inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanLevel":{
            "type":"number",
            "description":"An attribute which indicates the depth of the node (row) in the exploded tree. For example, a value 0 denotes that it is the root node.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningPercentage":{
            "title":"Planning Percent",
            "type":"number",
            "description":"An attribute used by forecast planning that represents the distribution percentage for a component.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUomCode":{
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ProductType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of product for the formula output.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"An attribute value the represents the quantity of component item used.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityRelatedFlag":{
            "title":"Quantity Related",
            "type":"boolean",
            "description":"An attribute that Identifiers to indicates if this component has quantity related reference designators.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplenishToOrderFlag":{
            "title":"Assemble to Order",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag indicating is generally built for sales order demand; a final assembly work order is created based on sales order details.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredForRevenueFlag":{
            "title":"Required for Revenue",
            "type":"boolean",
            "description":"A flag indicating if component is required  to recognize revenue before you ship the order.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredToShipFlag":{
            "title":"Required to Ship",
            "type":"boolean",
            "description":"A flag indicating if component is required to ship the order.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderBasisValue":{
            "type":"string",
            "description":"An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderTransactionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"A flag that is a reference to the source transaction definition that identifies the type of transactions within each application where a budgetary control transaction is originated.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippableItemFlag":{
            "title":"Shippable",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag indicating whether to ship an item to a customer.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowInSales":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ShowInSalesValue":{
            "type":"string",
            "description":"An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.",
            "nullable":true,
            "x-queryable":true
        },
        "SoBasis":{
            "title":"Sales Order Basis",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time on which a component in a structure begins.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedOperationSequence":{
            "title":"Suggested Operation Sequence",
            "type":"integer",
            "description":"An attribute value that holds the suggested operation sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyType":{
            "type":"string",
            "description":"An attribute indicating a supply type for components.",
            "nullable":true,
            "x-queryable":true
        },
        "ToNumber":{
            "title":"To End Item Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The item unit number or serial number up to which the component is effective. Valid only for unit or serial  effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "TopBillSequenceId":{
            "maxLength":256,
            "type":"string",
            "description":"A unique identifier for the bill sequence of the root item of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "TopItemId":{
            "maxLength":256,
            "type":"string",
            "description":"A unique identifier for the root item for the explosion of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "TopItemNumber":{
            "type":"string",
            "description":"An attribute value that is the identifier for the root item for the explosion of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "UsePlaceholderFlag":{
            "type":"boolean",
            "description":"An attribute that determines whether option class item data should be loaded into configurator models or not.",
            "nullable":true,
            "x-queryable":true
        },
        "UserItemTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"A unique value 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
        },
        "WipSupplyType":{
            "title":"Supply Type",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "Yield":{
            "title":"Yield",
            "type":"number",
            "description":"An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.",
            "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