REST API for Oracle Fusion Cloud SCM

Get all expanded component items

get

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

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.

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: Finds expansion components according to the primary key
  Finder Variables:
  - ComponentSequencePath; string; Value that uniquely identifies the expansion component sequence.
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; Value that indicates to check the following information when placing a demand: available to promise and capable to promise.
- ATPComponentFlag; boolean; Value that indicates to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
- ATPComponentsCode; string; Value that indicates 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; Value that indicates to check available to promise and or capable to promise information when placing demand.
- AutoRequestMaterialFlag; boolean; Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true.
- BasisType; number; Value that indicates that the option class quantity can be overridden by a sales order. Valid values include None, can override, or Option Class, can't override.
- BasisValue; string; Value that identifes that the option class quantity can be overridden by a sales order. Valid values include None or Option Class.
- CheckATPFlag; boolean; Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true.
- Comments; string; Comments about a component.
- CommonComponentSequenceId; number; Value that uniquely identifies a component in a structure.
- ComponentItemId; string; Value that uniquely identifies the item associated with the component.
- ComponentItemNumber; string; Number that identifies the item of a component.
- ComponentPath; string; Value that identifies the hierarchical path of a component item to the root item in a structure.
- ComponentSequenceId; number; Value that uniquely identifies a component in a structure.
- ComponentSequencePath; string; Value that identifies the hierarchical path or linage of a component item to the root item in a structure using the component sequence IDs.
- ComponentStructureItemTypeValue; string; Value that identifies whether the component sub-assembly is date effective or is model or unit effetive.
- ComponentUOMCodeValue; string; Value that identifies 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.
- CustomerOrderEnabledFlag; boolean; Value that indicates that an item is currently customer orderable.
- CustomerOrderFlag; boolean; Value that indicates that an item can be ordered by external customers.
- EndDateTime; string; Date and time when a component in a structure ends.
- EnforceIntRequirements; number; Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
- EnforceIntegerRequirementsValue; string; Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
- ExpandModelFlag; boolean; Value that identifies how model subassemblies are handled. If the the value is true, then the model subassemblies will be exploded.
- ExpandOption; integer; Value that identifies the expansion operation. The value include, 1 (All), 2 (Current), or 3 (Current and Future). The default option is 2 (Current).
- ExpansionDateTime; string; Value that identifies the structure expansion operation for date effective structures.
- ExpansionType; integer; Value that identifies the expansion type. The value include, 1 Optional, 2 Included, or 3 Both. The default value is 3 Both.
- ExtendedQuantity; number; Value that identifies the 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; Number that identifies the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
- FromSerialNumber; string; Number that identifies the item serial from which the component is effective in a structure. It's valid only for serial effective structures.
- FromUnitNumber; string; Number that identifies the item unit from which the component is effective. It is valid only for unit effective structures.
- ImplementationDate; string; Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components.
- ImplementationOnlyFlag; boolean; Value that identifies how unimplemented components are handled. If the the value is true, then the unimplemented components will be left out of the explosion process.
- IncludeOnShipDocsFlag; boolean; Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true.
- InstantiabilityCode; string; Abbreviation that identifies whether a component item is instantiable in an item structure.
- InstantiabilityValue; string; Value that indicates that a component item is instantiable in an item structure.
- InternalOrderEnabledFlag; boolean; Value indicating that an item can be ordered on an internal requisition.
- InternalOrderFlag; boolean; Value indicating that an Item can be ordered internally.
- InverseQuantity; number; Value that identifies the inverse of an exact or specified quantity defined for a structure component.
- ItemClassName; string; Name in metadata that is common to all items that share the category.
- ItemSequenceNumber; number; Number that idenfitifies the sequence of components in a structure.
- ItemStatus; string; Value that identifies the codes used to control the transaction activity of an item. For example, an item in active status can be customer-order enabled.
- MaximumQuantity; number; Value that identifies the maximum order quantity.
- MinimumQuantity; number; Value that identifies the minimum order quantity.
- MutuallyExclusiveFlag; boolean; Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true.
- OptionalFlag; boolean; Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true.
- 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.
- OrganizationId; string; Value that uniquely identifies the organization.
- ParentBillSequenceId; integer; Value that uniquely identifies the parent structure.
- ParentCommonBillSequenceId; integer; Value that uniquely identifies the parent bill structure.
- ParentComponentSequencePath; string; Value that identifies the hierarchical path or linage of a parent component item to the root item in a structure using the component sequence IDs.
- ParentEffectivityControl; number; Abbreviation that identifies the way effectively is controlled within the parent of the structure.
- ParentEffectivityControlValue; string; Value that identifies the way effectivety is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
- ParentItemId; string; Value that uniquely identifies 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; Number that uniquely identifies the parent identifier for a part, material, product, or service.
- ParentStructureDescription; string; Value that identifies the description of a parent structure.
- ParentStructureItemTypeValue; string; Value that indicates whether the structure is date effective or is model or unit effetive.
- ParentStructureName; string; Value that identifies the name of a parent structure.
- PickComponentFlag; boolean; Value indicating that an item has a structure l with options, classes, or included items picked from finished goods inventory.
- PlanLevel; number; Value which indicates the depth of the node, row, in the exploded tree. For example, a value of 0 denotes that it is the root node.
- PlanningPercentage; number; Value that identifies the distribution percentage for a component. It is used by forecast planning.
- PrimaryUOMValue; string; Value that identifies the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each.
- PrimaryUomCode; string; Value that identifies the primary unit of measure for the item quantities.
- Quantity; number; Value that identifies quantity of a component in a structure.
- QuantityRelatedFlag; boolean; Value that indicates that a component is quantity related. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.
- ReplenishToOrderFlag; boolean; Value that indicates the generally built for sales order demand; a final assembly work order is created based on sales order details.
- RequiredForRevenueFlag; boolean; Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true.
- RequiredToShipFlag; boolean; Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true.
- SalesOrderBasisValue; string; Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.
- SalesOrderTransactionFlag; boolean; Value that identifies 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; Value that indicates to ship an item to a customer.
- ShowInSales; number; Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
- ShowInSalesValue; string; Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
- SoBasis; number; Value that identifes the basis to override the default quantity for the option class when a sales order is entered, the default, for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.
- StartDateTime; string; Date and time when a component in a structure begins.
- SuggestedOperationSequence; integer; An attribute value that holds the suggested operation sequence.
- SupplyType; string; Value that identifies the type of supply for components.
- ToNumber; string; Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
- TopBillSequenceId; string; Value that uniquely identifies the bill sequence of the root item of the structure.
- TopItemId; string; Value that uniquely identifies the root item for the explosion of the structure.
- TopItemNumber; string; Value that identifies 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; Value that uniquely identifes 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; Value that identifies the type of supply for components.
- Yield; number; Value that identifies the planned or actual output of a process. Values include loss, 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:

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.

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.

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

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

ATPCode: string

Read Only: true

Value that indicates 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

Value that indicates to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
ATPComponentsCode: string

Read Only: true

Value that indicates 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

Value that indicates to check available to promise and or capable to promise information when placing demand.
AutoRequestMaterialFlag: boolean

Title: Automatically Request Material

Maximum Length: 1

Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true.
BasisType: number

Title: Basis

Value that indicates that the option class quantity can be overridden by a sales order. Valid values include None, can override, or Option Class, can't override.
BasisValue: string

Value that identifes that the option class quantity can be overridden by a sales order. Valid values include None or Option Class.
CheckATPFlag: boolean

Title: Check ATP

Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true.
Comments: string

Title: Comments

Maximum Length: 240

Comments about a component.
CommonComponentSequenceId: number

Value that uniquely identifies a component in a structure.
ComponentItemId: string

Maximum Length: 240

Value that uniquely identifies the item associated with the component.
ComponentItemNumber: string

Maximum Length: 40

Number that identifies the item of a component.
ComponentPath: string

Maximum Length: 4000

Value that identifies the hierarchical path of a component item to the root item in a structure.
ComponentSequenceId: number

Value that uniquely identifies a component in a structure.
ComponentSequencePath: string

Title: Path

Maximum Length: 32767

Value that identifies the hierarchical path or linage of a component item to the root item in a structure using the component sequence IDs.
ComponentStructureItemTypeValue: string

Value that identifies whether the component sub-assembly is date effective or is model or unit effetive.
ComponentUOMCodeValue: string

Maximum Length: 255

Value that identifies 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.
CustomerOrderEnabledFlag: boolean

Title: Customer Orders Enabled

Maximum Length: 1

Value that indicates that an item is currently customer orderable.
CustomerOrderFlag: boolean

Title: Customer Ordered

Maximum Length: 1

Value that indicates that an item can be ordered by external customers.
EndDateTime: string (date)

Title: End Date

Date and time when a component in a structure ends.
EnforceIntegerRequirementsValue: string

Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
EnforceIntRequirements: number

Title: Enforce Integer Requirement

Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
ExpandModelFlag: boolean

Read Only: true

Value that identifies how model subassemblies are handled. If the the value is true, then the model subassemblies will be exploded.
ExpandOption: integer

Read Only: true

Value that identifies the expansion operation. The value include, 1 (All), 2 (Current), or 3 (Current and Future). The default option is 2 (Current).
ExpansionDateTime: string (date-time)

Read Only: true

Value that identifies the structure expansion operation for date effective structures.
ExpansionType: integer

Read Only: true

Value that identifies the expansion type. The value include, 1 Optional, 2 Included, or 3 Both. The default value is 3 Both.
ExtendedQuantity: number

Value that identifies the 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

Number that identifies the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
FromSerialNumber: string

Read Only: true

Maximum Length: 30

Number that identifies the item serial from which the component is effective in a structure. It's valid only for serial effective structures.
FromUnitNumber: string

Read Only: true

Maximum Length: 30

Number that identifies the item unit from which the component is effective. It is valid only for unit effective structures.
ImplementationDate: string (date)

Title: Effective Date

Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components.
ImplementationOnlyFlag: boolean

Read Only: true

Value that identifies how unimplemented components are handled. If the the value is true, then the unimplemented components will be left out of the explosion process.
IncludeOnShipDocsFlag: boolean

Title: Include on Shipping Documents

Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true.
InstantiabilityCode: string

Maximum Length: 30

Abbreviation that identifies whether a component item is instantiable in an item structure.
InstantiabilityValue: string

Value that indicates that a component item is instantiable in an item structure.
InternalOrderEnabledFlag: boolean

Title: Transfer Orders Enabled

Maximum Length: 1

Value indicating that an item can be ordered on an internal requisition.
InternalOrderFlag: boolean

Title: Internally Transferable

Maximum Length: 1

Value indicating that an Item can be ordered internally.
InverseQuantity: number

Value that identifies the inverse of an exact or specified quantity defined for a structure component.
ItemClassName: string

Name in metadata that is common to all items that share the category.
ItemSequenceNumber: number

Title: Item Sequence

Number that idenfitifies the sequence of components in a structure.
ItemStatus: string

Maximum Length: 30

Value that identifies the 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

Value that identifies the maximum order quantity.
MinimumQuantity: number

Title: Minimum Quantity

Value that identifies the minimum order quantity.
MutuallyExclusiveFlag: boolean

Title: Mutually Exclusive

Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true.
OptionalFlag: boolean

Title: Optional

Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true.
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.
OrganizationId: string

Maximum Length: 240

Value that uniquely identifies the organization.
ParentBillSequenceId: integer (int64)

Value that uniquely identifies the parent structure.
ParentCommonBillSequenceId: integer (int64)

Value that uniquely identifies the parent bill structure.
ParentComponentSequencePath: string

Maximum Length: 32767

Value that identifies the hierarchical path or linage of a parent component item to the root item in a structure using the component sequence IDs.
ParentEffectivityControl: number

Abbreviation that identifies the way effectively is controlled within the parent of the structure.
ParentEffectivityControlValue: string

Value that identifies the way effectivety is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
ParentItemId: string

Maximum Length: 240

Value that uniquely identifies 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

Number that uniquely identifies the parent identifier for a part, material, product, or service.
ParentStructureDescription: string

Title: Description

Maximum Length: 240

Value that identifies the description of a parent structure.
ParentStructureItemTypeValue: string

Value that indicates whether the structure is date effective or is model or unit effetive.
ParentStructureName: string

Maximum Length: 255

Value that identifies the name of a parent structure.
PickComponentFlag: boolean

Title: Pick Components

Value indicating that an item has a structure l with options, classes, or included items picked from finished goods inventory.
PlanLevel: number

Value which indicates the depth of the node, row, in the exploded tree. For example, a value of 0 denotes that it is the root node.
PlanningPercentage: number

Title: Planning Percent

Value that identifies the distribution percentage for a component. It is used by forecast planning.
PrimaryUomCode: string

Maximum Length: 3

Value that identifies the primary unit of measure for the item quantities.
PrimaryUOMValue: string

Maximum Length: 255

Value that identifies the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each.
Quantity: number

Title: Quantity

Value that identifies quantity of a component in a structure.
QuantityRelatedFlag: boolean

Title: Quantity Related

Value that indicates that a component is quantity related. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.
ReplenishToOrderFlag: boolean

Title: Assemble to Order

Maximum Length: 1

Value that indicates the generally built for sales order demand; a final assembly work order is created based on sales order details.
RequiredForRevenueFlag: boolean

Title: Required for Revenue

Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true.
RequiredToShipFlag: boolean

Title: Required to Ship

Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true.
SalesOrderBasisValue: string

Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.
SalesOrderTransactionFlag: boolean

Maximum Length: 1

Value that identifies 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

Value that indicates to ship an item to a customer.
ShowInSales: number

Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
ShowInSalesValue: string

Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
SoBasis: number

Title: Sales Order Basis

Value that identifes the basis to override the default quantity for the option class when a sales order is entered, the default, for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.
StartDateTime: string (date)

Title: Start Date

Date and time when 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

Value that identifies the type of supply for components.
ToNumber: string

Title: To End Item Unit Number

Maximum Length: 30

Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
TopBillSequenceId: string

Maximum Length: 256

Value that uniquely identifies the bill sequence of the root item of the structure.
TopItemId: string

Maximum Length: 256

Value that uniquely identifies the root item for the explosion of the structure.
TopItemNumber: string

Value that identifies 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

Value that uniquely identifes 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

Value that identifies the type of supply for components.
Yield: number

Title: Yield

Value that identifies the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.

{
    "type":"object",
    "properties":{
        "ItemStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the 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":{
            "type":"string",
            "description":"Name in metadata that is common to all items that share the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ATPComponentsCode":{
            "type":"string",
            "description":"Value that indicates 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
        },
        "SalesOrderTransactionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies 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
        },
        "PlanLevel":{
            "type":"number",
            "description":"Value which indicates the depth of the node, row, in the exploded tree. For example, a value of 0 denotes that it is the root node.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"Value that identifies the maximum order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalOrderFlag":{
            "title":"Internally Transferable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating that an Item can be ordered internally.",
            "nullable":true,
            "x-queryable":true
        },
        "PickComponentFlag":{
            "title":"Pick Components",
            "type":"boolean",
            "description":"Value indicating that an item has a structure l with options, classes, or included items picked from finished goods inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "FromSerialNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the item serial from which the component is effective in a structure. It's valid only for serial effective structures.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentSequencePath":{
            "title":"Path",
            "maxLength":"32767",
            "type":"string",
            "description":"Value that identifies 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
        },
        "RequiredForRevenueFlag":{
            "title":"Required for Revenue",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true.",
            "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
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"integer",
            "description":"An attribute value that holds find number for the component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCommonBillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent bill structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ComponentStructureItemTypeValue":{
            "type":"string",
            "description":"Value that identifies whether the component sub-assembly is date effective or is model or unit effetive.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementationDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityRelatedFlag":{
            "title":"Quantity Related",
            "type":"boolean",
            "description":"Value that indicates that a component is quantity related. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalOrderEnabledFlag":{
            "title":"Transfer Orders Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating that an item can be ordered on an internal requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyType":{
            "type":"string",
            "description":"Value that identifies the type of supply for components.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentBillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentStructureName":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the name of a parent structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowInSalesValue":{
            "type":"string",
            "description":"Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippableItemFlag":{
            "title":"Shippable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates to ship an item to a customer.",
            "nullable":true,
            "x-queryable":true
        },
        "UserItemTypeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifes 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
        },
        "ParentStructureItemTypeValue":{
            "type":"string",
            "description":"Value that indicates whether the structure is date effective or is model or unit effetive.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoRequestMaterialFlag":{
            "title":"Automatically Request Material",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentUOMCodeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies 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 &quot;Box&quot; , but it may have a unit of measurement &quot;Each&quot; when used as component of a table.",
            "nullable":true,
            "x-queryable":true
        },
        "ATPComponentFlag":{
            "title":"Available to Promise",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.",
            "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
        },
        "SuggestedOperationSequence":{
            "title":"Suggested Operation Sequence",
            "type":"integer",
            "description":"An attribute value that holds the suggested operation sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToNumber":{
            "title":"To End Item Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEffectivityControl":{
            "type":"number",
            "description":"Abbreviation that identifies the way effectively is controlled within the parent of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceIntRequirements":{
            "title":"Enforce Integer Requirement",
            "type":"number",
            "description":"Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentStructureDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the description of a parent structure.",
            "nullable":true,
            "x-queryable":true
        },
        "InstantiabilityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies whether a component item is instantiable in an item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "InstantiabilityValue":{
            "type":"string",
            "description":"Value that indicates that a component item is instantiable in an item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEffectivityControlValue":{
            "type":"string",
            "description":"Value that identifies the way effectivety is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentComponentSequencePath":{
            "maxLength":"32767",
            "type":"string",
            "description":"Value that identifies 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
        },
        "ComponentItemId":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the item associated with the component.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUomCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Value that identifies the primary unit of measure for the item quantities.",
            "nullable":true,
            "x-queryable":true
        },
        "WipSupplyType":{
            "title":"Supply Type",
            "type":"number",
            "description":"Value that identifies the type of supply for components.",
            "nullable":true,
            "x-queryable":true
        },
        "FromNumber":{
            "title":"From End Item Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerOrderEnabledFlag":{
            "title":"Customer Orders Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates that an item is currently customer orderable.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseQuantity":{
            "type":"number",
            "description":"Value that identifies the inverse of an exact or specified quantity defined for a structure component.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpandOption":{
            "type":"integer",
            "description":"Value that identifies the expansion operation. The value include, 1 (All), 2 (Current), or 3 (Current and Future). The default option is 2 (Current).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "FromUnitNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the item unit from which the component is effective. It is valid only for unit effective structures.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "title":"End Date",
            "type":"string",
            "description":"Date and time when a component in a structure ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpansionDateTime":{
            "type":"string",
            "description":"Value that identifies the structure expansion operation for date effective structures.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TopItemId":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that uniquely identifies the root item for the explosion of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeOnShipDocsFlag":{
            "title":"Include on Shipping Documents",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "ATPCode":{
            "type":"string",
            "description":"Value that indicates to check the following information when placing a demand: available to promise and capable to promise.",
            "nullable":true,
            "readOnly":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
        },
        "CommonComponentSequenceId":{
            "type":"number",
            "description":"Value that uniquely identifies a component in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"Number that identifies the item of a component.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerOrderFlag":{
            "title":"Customer Ordered",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates that an item can be ordered by external customers.",
            "nullable":true,
            "x-queryable":true
        },
        "ATPFlag":{
            "title":"Available to Promise",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates to check available to promise and or capable to promise information when placing demand.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpandModelFlag":{
            "type":"boolean",
            "description":"Value that identifies how model subassemblies are handled. If the the value is true, then the model subassemblies will be exploded.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnforceIntegerRequirementsValue":{
            "type":"string",
            "description":"Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSequenceNumber":{
            "title":"Item Sequence",
            "type":"number",
            "description":"Number that idenfitifies the sequence of components in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowInSales":{
            "type":"number",
            "description":"Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"240",
            "type":"string",
            "description":"Comments about a component.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningPercentage":{
            "title":"Planning Percent",
            "type":"number",
            "description":"Value that identifies the distribution percentage for a component. It is used by forecast planning.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Value that identifies quantity of a component in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisValue":{
            "type":"string",
            "description":"Value that identifes that the option class quantity can be overridden by a  sales order. Valid values include None or Option Class.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckATPFlag":{
            "title":"Check ATP",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpansionType":{
            "type":"integer",
            "description":"Value that identifies the expansion type. The value include, 1 Optional, 2 Included, or 3 Both. The default value is 3 Both.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TopBillSequenceId":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that uniquely identifies the bill sequence of the root item of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"number",
            "description":"Value that uniquely identifies a component in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"Value that identifies the minimum order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalFlag":{
            "title":"Optional",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentItemId":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies 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
        },
        "RequiredToShipFlag":{
            "title":"Required to Ship",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplenishToOrderFlag":{
            "title":"Assemble to Order",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates the generally built for sales order demand; a final assembly work order is created based on sales order details.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentPath":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the hierarchical path of a component item to the root item in a structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementationOnlyFlag":{
            "type":"boolean",
            "description":"Value that identifies how unimplemented components are handled. If the the value is true, then the unimplemented components will be left out of the explosion process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TopItemNumber":{
            "type":"string",
            "description":"Value that identifies the root item for the explosion of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "title":"Start Date",
            "type":"string",
            "description":"Date and time when a component in a structure begins.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Basis",
            "type":"number",
            "description":"Value that indicates that the option class quantity can be overridden by a sales order. Valid values include None, can override, or Option Class, can't override.",
            "nullable":true,
            "x-queryable":true
        },
        "MutuallyExclusiveFlag":{
            "title":"Mutually Exclusive",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderBasisValue":{
            "type":"string",
            "description":"Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendedQuantity":{
            "type":"number",
            "description":"Value that identifies the calculated total quantity of the component used in the whole explosion.",
            "nullable":true,
            "x-queryable":true
        },
        "Yield":{
            "title":"Yield",
            "type":"number",
            "description":"Value that identifies the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SoBasis":{
            "title":"Sales Order Basis",
            "type":"number",
            "description":"Value that identifes the basis to override the default quantity for the option class when a sales order is entered, the default, for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.",
            "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."
        }
    }
}