REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get all product structures

get

/crmRestApi/resources/11.13.18.05/productStructures

Request

Query Parameters

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:
- AltKey: Finds a product structure with the specified value.
  Finder Variables:
  - ItemId; string.
  - OrganizationId; string.
- PrimaryKey: Finds a product structure with the specified primary key.
  Finder Variables:
  - BillSequenceId; integer; The unique identifier of the product structure.
- getStructureByItemNumber: Finds a product structure with specified item number.
  Finder Variables:
  - ItemNumber; string; The number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
  - OrganizationCode; string; Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise.
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:
- BillSequenceId; integer; The unique identifier of the bill sequence. A value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
- CommonItemNumber; string; The number that identifies the item for the common structure. This attribute is read-only.
- CommonOrganizationCode; string; The name of the organization for the common structure. This attribute is read-only.
- CreatedBy; string; The user who created the structure.
- CreationDateTime; string; The date and time when the structure was created.
- Description; string; The description for structure.
- ItemId; string; The unique identifier of the part, item, product, or service.
- ItemNumber; string; The number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
- LastUpdateDateTime; string; The date and time when the structure was last updated.
- LastUpdateLogin; string; The login of the user who last updated the structure.
- LastUpdatedBy; string; The user who last updated the structure.
- 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; The unique identifier of the organization.
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 : productStructures

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/productStructures-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object productStructures-item-response

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

Type: object

Show Source

BillSequenceId: integer

Title: Bill Sequence Id

Read Only: true

The unique identifier of the bill sequence. A value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
CommonItemNumber: string

Title: Common Item Number

Read Only: true

Maximum Length: 255

The number that identifies the item for the common structure. This attribute is read-only.
CommonOrganizationCode: string

Title: Common Organization Code

Read Only: true

Maximum Length: 255

The name of the organization for the common structure. This attribute is read-only.
Component: array Components

Title: Components

The components resource is used to view, create, and update the details of a component within a structure.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the structure.
CreationDateTime: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the structure was created.
Description: string

Title: Description

Maximum Length: 240

The description for structure.
ItemId: string

Title: Inventory Item ID

Maximum Length: 240

The unique identifier of the part, item, product, or service.
ItemNumber: string

Title: Product Number

The number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
LastUpdateDateTime: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the structure was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the structure.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the structure.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrganizationCode: string

Title: Organization Code

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

Title: Organization ID

Maximum Length: 240

The unique identifier of the organization.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the structure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the structure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for structure.",
            "nullable":true,
            "x-queryable":true
        },
        "CommonItemNumber":{
            "title":"Common Item Number",
            "maxLength":"255",
            "type":"string",
            "description":"The number that identifies the item for the common structure. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the structure was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "maxLength":"240",
            "type":"string",
            "description":"The unique identifier of the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Inventory Item ID",
            "maxLength":"240",
            "type":"string",
            "description":"The unique identifier of the part, item, product, or service.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDateTime":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the structure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Number",
            "type":"string",
            "description":"The number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CommonOrganizationCode":{
            "title":"Common Organization Code",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the organization for the common structure. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Component":{
            "title":"Components",
            "type":"array",
            "description":"The components resource is used to view, create, and update the details of a component within a structure.",
            "items":{
                "$ref":"#/components/schemas/productStructures-Component-item-response"
            }
        },
        "BillSequenceId":{
            "title":"Bill Sequence Id",
            "type":"integer",
            "description":"The unique identifier of the bill sequence. A value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Components

Type: array

Title: Components

The components resource is used to view, create, and update the details of a component within a structure.

Show Source

Array of: object productStructures-Component-item-response

{
    "title":"Components",
    "type":"array",
    "description":"The components resource is used to view, create, and update the details of a component within a structure.",
    "items":{
        "$ref":"#/components/schemas/productStructures-Component-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 : productStructures-Component-item-response

Type: object

Show Source

BillSequenceId: integer

Title: Bill Sequence Id

Value that uniquely identifies the bill of material. This is the foreign key to the Structure view object. This attribute is read-only, and can be modified only if the resource is already modified.
BOMItemType: number

Title: Structure Item Type

The type of bill of material associated with the cpomponent such as standard, model, planning, and other.
Comments: string

Title: Comments

Maximum Length: 240

An attribute value that represents comments about a component.
ComponentItemDescription: string

Title: Description

Read Only: true

Maximum Length: 255

The description of the item associated with the component.
ComponentItemId: string

Title: Inventory Item ID

Maximum Length: 240

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

Title: Product

Read Only: true

Maximum Length: 255

The name of the item associated with the component.
ComponentItemNumber: string

Title: Component Product Number

An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.
ComponentOrganizationCode: string

Title: Component Organization Code

Maximum Length: 255

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.
ComponentSequenceId: integer

Title: Component Sequence Id

Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
ComponentStructureItemTypeValue: string

Title: Component Structure Item Type Value

Maximum Length: 255

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

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the component.
CreationDateTime: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the structure was created.
CustomerOrderEnabledFlag: boolean

Title: Customer Order Enabled

Maximum Length: 1

Indicates whether the custom order is enabled. The values are true and false. If true, then the item can be ordered by external customers at this point of time. If false, then the item can't be ordered by external customers at this point of time. The default value is false. For a list of attribute value interdependencies, refer to Interdependent Item Attributes in Using Product Master Data Management Guide.
EndDateTime: string (date-time)

Title: End Date Time

The date and time when a component in a structure ends.
ImplementationDateTime: string (date-time)

Title: Implementation Date Time

Read Only: true

This attributes provides the timestamp when the component was implemented as production row. This attribute can be used to differentiate among pending and production components. For pending components this will be null. This is read only attribute.
ItemSequenceNumber: number

Title: Item Sequence

A unique number which defines the sequence of components in a structure.
LastUpdateDateTime: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the structure was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the component.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the component.
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

Default Value: false

Indicates whether one or more options under this Option Class can be chosen.
OptionalFlag: boolean

Title: Required

Default Value: false

Indicates whether the component is optional for a structure.
OrganizationId: string

Title: Component Organization ID

Maximum Length: 240

Value that uniquely identifies the organization.
PrimaryUOMCode: string

Title: Primary Unit of Measure

Maximum Length: 30

Primary unit of measure for the item quantities.
Quantity: number

Title: Quantity

Default Value: 1

An attribute value the represents the quantity of component item used.
SoBasis: number

Title: Quantity Editable

Default Value: 2

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

Title: Start Date Time

The date and time when a component in a structure begins.
StructureItemNumber: string

Title: Structure Product Number

Maximum Length: 255

Number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
StructureOrganizationCode: string

Title: Structure Organization Code

Maximum Length: 255

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.
WIPSupplyType: integer

Title: Supply Type

Type of supply for components.

{
    "type":"object",
    "properties":{
        "ComponentItemId":{
            "title":"Inventory Item ID",
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the item associated with the component.",
            "nullable":false,
            "x-queryable":true
        },
        "ImplementationDateTime":{
            "title":"Implementation Date Time",
            "type":"string",
            "description":"This attributes provides the timestamp when the component was implemented as production row. This attribute can be used to differentiate among pending and production components. For pending components this will be null. This is read only attribute.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the structure was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerOrderEnabledFlag":{
            "title":"Customer Order Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the custom order is enabled. The values are true and false. If true, then the item can be ordered by external customers at this point of time. If false, then the item can't be ordered by external customers at this point of time. The default value is false. For a list of attribute value interdependencies, refer to Interdependent Item Attributes in Using Product Master Data Management Guide.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Component Organization ID",
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the organization.",
            "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
        },
        "StructureOrganizationCode":{
            "title":"Structure Organization Code",
            "maxLength":"255",
            "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BOMItemType":{
            "title":"Structure Item Type",
            "type":"number",
            "description":"The type of bill of material associated with the cpomponent such as standard, model, planning, and other.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDateTime":{
            "title":"End Date Time",
            "type":"string",
            "description":"The date and time when a component in a structure ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentStructureItemTypeValue":{
            "title":"Component Structure Item Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies whether the component sub-assembly is date effective or is model or unit effective.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentItemNumber":{
            "title":"Component Product Number",
            "type":"string",
            "description":"An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ComponentOrganizationCode":{
            "title":"Component Organization Code",
            "maxLength":"255",
            "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ComponentItemName":{
            "title":"Product",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the item associated with the component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemDescription":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the item associated with the component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillSequenceId":{
            "title":"Bill Sequence Id",
            "type":"integer",
            "description":"Value that uniquely identifies the bill of material. This is the foreign key to the Structure view object. This attribute is read-only, and can be modified only if the resource is already modified.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemSequenceNumber":{
            "title":"Item Sequence",
            "type":"number",
            "description":"A unique number which defines the sequence of components in a structure.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "title":"Primary Unit of Measure",
            "maxLength":"30",
            "type":"string",
            "description":"Primary unit of measure for the item quantities.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the component.",
            "nullable":false,
            "readOnly":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
        },
        "StructureItemNumber":{
            "title":"Structure Product Number",
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"An attribute value the represents the quantity of component item used.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "title":"Component Sequence Id",
            "type":"integer",
            "description":"Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.",
            "nullable":false,
            "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
        },
        "OptionalFlag":{
            "title":"Required",
            "type":"boolean",
            "description":"Indicates whether the component is optional for a structure.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "WIPSupplyType":{
            "title":"Supply Type",
            "type":"integer",
            "description":"Type of supply for components.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the structure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "title":"Start Date Time",
            "type":"string",
            "description":"The date and time when a component in a structure begins.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MutuallyExclusiveFlag":{
            "title":"Mutually Exclusive",
            "type":"boolean",
            "description":"Indicates whether one or more options under this Option Class can be chosen.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SoBasis":{
            "title":"Quantity Editable",
            "type":"number",
            "description":"Value that indicates 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,
            "default":"2",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

getStructureHierarchy: Operation: /crmRestApi/resources/11.13.18.05/productStructures/action/getStructureHierarchy

This method gives you the product structure hierarchy across all levels.