Jump to

• Request
• Response

Get all bill of resources

get

/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/BillOfResourcesV2

Request

Path Parameters

• PlanInputId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the bill of resources using the primary key.
    Finder Variables
    • DerivedBorId; string; Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.
• 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:
  

  • AlternateResourceCode; string; Abbreviation that identifies the alternate resource.
  • AlternateResourceId; number; Value that uniquely identifies the alternate resource.
  • AlternateResourcePriority; number; Value that indicates the priority associated with the resource to use as the alternate resource.
  • AlternateResourceQuantity; number; Value that indicates the quantity of the alternate resource being consumed.
  • AlternateResourceUOM; string; Unit of measure associated with the alternate resource.
  • AlternateWorkCenterCode; string; Abbreviation that identifies the work center to which the alternate resource belongs to in the bill of resources.
  • AlternateWorkCenterId; integer; Value that uniquely identifies the work center to which the alternate resource belongs to in bill of resources.
  • AssemblyDescription; string; Description of the assembly item.
  • AssemblyItemId; integer; Value that uniquely identifies the assembly item.
  • AssemblyItemLevel; string; Data load level of the item being produced. Valid values are Item and Category.
  • AssemblyItemName; string; Name of the assembly item.
  • AssemblyQuantity; number; Quantity of the item being produced.
  • AssemblyUOM; string; Planning unit of measure of the assembly item.
  • BasisType; number; Value that indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable. Contains one of the following values: 1 or 2. If 1, then usage quantity is variable. If 2, then usage quantity is fixed. The default value is 1.
  • BasisTypeMeaning; string; Indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable.
  • BorId; integer; Value that uniquely identifies the bill of resources.
  • CatalogId; integer; Value that uniquely identifies the catalog.
  • CatalogName; string; Category set or name of the catalog to which an item belongs. If Assembly Item Level is set to Category, then this value is required.
  • CategoryId; integer; Value that uniquely identifies the category.
  • CategoryName; string; Name of the category to which an item belongs. If Assembly Item Level is set to Category, then this value is required.
  • CategoryUOM; string; Planning unit of measure of the category.
  • ComponentDescription; string; Description of the component item.
  • ComponentItemId; integer; Value that uniquely identifies the component item.
  • ComponentItemName; string; Name of the component item.
  • ComponentUOM; string; Planning unit of measure of the component item.
  • ComponentUsageQuantity; number; Quantity of the item being consumed.
  • ConsumptionType; string; Type of consumption. This attribute indicates whether an item or resource is being consumed. Valid values are Item and Resource.
  • CreatedBy; string; User who created the bill of resources.
  • CreationDate; string; Date and time when the user created the bill of resources.
  • DerivedBorId; string; Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.
  • EffectiveEndDate; string; Date when the component item or resource is no longer available.
  • EffectiveStartDate; string; Date when the component item or resource is available.
  • FindNumber; number; Number that uniquely identifies a component when the same component occurs multiple times at the same level in a bill of material.
  • LastUpdateDate; string; Date and time when the user most recently updated the bill of resources.
  • LastUpdatedBy; string; User who most recently updated the bill of resources.
  • LeadTimeOffsetInDays; number; Value that indicates the number of days for which the planning engine offsets the consumption of a component or resource.
  • OptionDependent; number; Value that indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Contains one of the following values: 1 or 2. If 1, then the resource is option dependent. If 2, then the resource isn't option dependent. This attribute doesn't have a default value.
  • OptionDependentMeaning; string; Indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Valid values are: Yes or No. If Yes, then the resource is option dependent. If No, then the resource isn't option dependent.
  • Organization; string; Abbreviation that identifies the organization associated with the item.
  • OrganizationId; integer; Value that uniquely identifies the organization.
  • OrganizationName; string; Name of the organization for the assembly item.
  • ResourceCode; string; Abbreviation that identifies the resource.
  • ResourceId; integer; Value that uniquely identifies the resource.
  • ResourceUOM; string; Unit of measure associated with the resource.
  • ResourceUsageQuantity; number; Quantity of the resource being consumed.
  • SourceOrganization; string; Abbreviation that identifies the organization where the component or resource is defined.
  • SourceOrganizationId; integer; Value that uniquely identifies the source organization.
  • SourceOrganizationName; string; Name of the organization where the component or resource is defined.
  • SubstituteComponentItemDescription; string; Description of the substitute component item.
  • SubstituteComponentItemId; number; Value that uniquely identifies the component item to use as the substitute component in the bill of resources.
  • SubstituteComponentItemName; string; Name of the component item to use as the substitute component in the bill of resources.
  • SubstituteComponentItemPriority; number; Value that indicates the priority associated with the component item to use as the substitute component in the bill of resources.
  • SubstituteComponentItemQuantity; number; Value that indicates the quantity of the substitute component being consumed.
  • SubstituteComponentItemUOM; string; Unit of measure associated with the substitute component.
  • WorkCenterCode; string; Abbreviation that identifies the work center.
  • WorkCenterId; integer; Value that uniquely identifies the work center.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : planInputs-BillOfResourcesV2

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/planInputs-BillOfResourcesV2-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object planInputs-BillOfResourcesV2-item-response

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

Type: object

Show Source

• AlternateResourceCode: string
  Read Only: true

  Maximum Length: 40

  Abbreviation that identifies the alternate resource.
• AlternateResourceId: number
  Read Only: true

  Value that uniquely identifies the alternate resource.
• AlternateResourcePriority: number
  Read Only: true

  Value that indicates the priority associated with the resource to use as the alternate resource.
• AlternateResourceQuantity: number
  Read Only: true

  Value that indicates the quantity of the alternate resource being consumed.
• AlternateResourceUOM: string
  Read Only: true

  Maximum Length: 4000

  Unit of measure associated with the alternate resource.
• AlternateWorkCenterCode: string
  Read Only: true

  Maximum Length: 120

  Abbreviation that identifies the work center to which the alternate resource belongs to in the bill of resources.
• AlternateWorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center to which the alternate resource belongs to in bill of resources.
• AssemblyDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the assembly item.
• AssemblyItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the assembly item.
• AssemblyItemLevel: string
  Read Only: true

  Maximum Length: 10

  Data load level of the item being produced. Valid values are Item and Category.
• AssemblyItemName: string
  Read Only: true

  Maximum Length: 300

  Name of the assembly item.
• AssemblyQuantity: number
  Read Only: true

  Quantity of the item being produced.
• AssemblyUOM: string
  Read Only: true

  Maximum Length: 4000

  Planning unit of measure of the assembly item.
• BasisType: number
  Read Only: true

  Value that indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable. Contains one of the following values: 1 or 2. If 1, then usage quantity is variable. If 2, then usage quantity is fixed. The default value is 1.
• BasisTypeMeaning: string
  Read Only: true

  Maximum Length: 4000

  Indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable.
• BorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bill of resources.
• CatalogId: integer (int64)
  Read Only: true

  Value that uniquely identifies the catalog.
• CatalogName: string
  Read Only: true

  Maximum Length: 30

  Category set or name of the catalog to which an item belongs. If Assembly Item Level is set to Category, then this value is required.
• CategoryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the category.
• CategoryName: string
  Read Only: true

  Maximum Length: 250

  Name of the category to which an item belongs. If Assembly Item Level is set to Category, then this value is required.
• CategoryUOM: string
  Read Only: true

  Maximum Length: 3

  Planning unit of measure of the category.
• ComponentDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the component item.
• ComponentItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the component item.
• ComponentItemName: string
  Read Only: true

  Maximum Length: 300

  Name of the component item.
• ComponentUOM: string
  Read Only: true

  Maximum Length: 4000

  Planning unit of measure of the component item.
• ComponentUsageQuantity: number
  Read Only: true

  Quantity of the item being consumed.
• ConsumptionType: string
  Read Only: true

  Maximum Length: 10

  Type of consumption. This attribute indicates whether an item or resource is being consumed. Valid values are Item and Resource.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the bill of resources.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the bill of resources.
• DerivedBorId: string
  Read Only: true

  Maximum Length: 81

  Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.
• EffectiveEndDate: string (date)
  Read Only: true

  Date when the component item or resource is no longer available.
• EffectiveStartDate: string (date)
  Read Only: true

  Date when the component item or resource is available.
• FindNumber: number
  Read Only: true

  Number that uniquely identifies a component when the same component occurs multiple times at the same level in a bill of material.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the bill of resources.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the bill of resources.
• LeadTimeOffsetInDays: number
  Read Only: true

  Value that indicates the number of days for which the planning engine offsets the consumption of a component or resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptionDependent: number
  Read Only: true

  Value that indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Contains one of the following values: 1 or 2. If 1, then the resource is option dependent. If 2, then the resource isn't option dependent. This attribute doesn't have a default value.
• OptionDependentDetailsV2: array Option Dependent Resource Details V2
  Title: Option Dependent Resource Details V2

  Details of resources used in operations that depend on the selection of one or more optional components, provided as input for supply chain planning activities.
• OptionDependentMeaning: string
  Read Only: true

  Maximum Length: 4000

  Indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Valid values are: Yes or No. If Yes, then the resource is option dependent. If No, then the resource isn't option dependent.
• Organization: string
  Read Only: true

  Maximum Length: 49

  Abbreviation that identifies the organization associated with the item.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization for the assembly item.
• ResourceCode: string
  Read Only: true

  Maximum Length: 40

  Abbreviation that identifies the resource.
• ResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource.
• ResourceUOM: string
  Read Only: true

  Maximum Length: 4000

  Unit of measure associated with the resource.
• ResourceUsageQuantity: number
  Read Only: true

  Quantity of the resource being consumed.
• SourceOrganization: string
  Read Only: true

  Maximum Length: 49

  Abbreviation that identifies the organization where the component or resource is defined.
• SourceOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the source organization.
• SourceOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization where the component or resource is defined.
• SubstituteComponentItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the substitute component item.
• SubstituteComponentItemId: number
  Read Only: true

  Value that uniquely identifies the component item to use as the substitute component in the bill of resources.
• SubstituteComponentItemName: string
  Read Only: true

  Maximum Length: 300

  Name of the component item to use as the substitute component in the bill of resources.
• SubstituteComponentItemPriority: number
  Read Only: true

  Value that indicates the priority associated with the component item to use as the substitute component in the bill of resources.
• SubstituteComponentItemQuantity: number
  Read Only: true

  Value that indicates the quantity of the substitute component being consumed.
• SubstituteComponentItemUOM: string
  Read Only: true

  Maximum Length: 3

  Unit of measure associated with the substitute component.
• WorkCenterCode: string
  Read Only: true

  Maximum Length: 120

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center.

{
    "type":"object",
    "properties":{
        "AlternateResourceCode":{
            "maxLength":40,
            "type":"string",
            "description":"Abbreviation that identifies the alternate resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateResourceId":{
            "type":"number",
            "description":"Value that uniquely identifies the alternate resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateResourcePriority":{
            "type":"number",
            "description":"Value that indicates the priority associated with the resource to use as the alternate resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateResourceQuantity":{
            "type":"number",
            "description":"Value that indicates the quantity of the alternate resource being consumed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateResourceUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure associated with the alternate resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateWorkCenterCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work center to which the alternate resource belongs to in the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateWorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center to which the alternate resource belongs to in bill of resources.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssemblyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assembly item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssemblyItemLevel":{
            "maxLength":10,
            "type":"string",
            "description":"Data load level of the item being produced. Valid values are Item and Category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyQuantity":{
            "type":"number",
            "description":"Quantity of the item being produced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Planning unit of measure of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisType":{
            "type":"number",
            "description":"Value that indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable. Contains one of the following values: 1 or 2. If 1, then usage quantity is variable. If 2, then usage quantity is fixed. The default value is 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisTypeMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill of resources.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CatalogName":{
            "maxLength":30,
            "type":"string",
            "description":"Category set or name of the catalog to which an item belongs. If Assembly Item Level is set to Category, then this value is required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the category to which an item belongs. If Assembly Item Level is set to Category, then this value is required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Planning unit of measure of the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the component item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ComponentItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the component item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Planning unit of measure of the component item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentUsageQuantity":{
            "type":"number",
            "description":"Quantity of the item being consumed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionType":{
            "maxLength":10,
            "type":"string",
            "description":"Type of consumption. This attribute indicates whether an item or resource is being consumed. Valid values are Item and Resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the bill of resources.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedBorId":{
            "maxLength":81,
            "type":"string",
            "description":"Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date when the component item or resource is no longer available.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date when the component item or resource is available.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FindNumber":{
            "type":"number",
            "description":"Number that uniquely identifies a component when the same component occurs multiple times at the same level in a bill of material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the bill of resources.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadTimeOffsetInDays":{
            "type":"number",
            "description":"Value that indicates the number of days for which the planning engine offsets the consumption of a component or resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionDependent":{
            "type":"number",
            "description":"Value that indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Contains one of the following values: 1 or 2. If 1, then the resource is option dependent. If 2, then the resource isn't option dependent. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionDependentDetailsV2":{
            "title":"Option Dependent Resource Details V2",
            "type":"array",
            "description":"Details of resources used in operations that depend on the selection of one or more optional components, provided as input for supply chain planning activities.",
            "items":{
                "$ref":"#/components/schemas/planInputs-BillOfResourcesV2-OptionDependentDetailsV2-item-response"
            }
        },
        "OptionDependentMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Valid values are: Yes or No. If Yes, then the resource is option dependent. If No, then the resource isn't option dependent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":49,
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization for the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":40,
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceUsageQuantity":{
            "type":"number",
            "description":"Quantity of the resource being consumed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "maxLength":49,
            "type":"string",
            "description":"Abbreviation that identifies the organization where the component or resource is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization where the component or resource is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the substitute component item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentItemId":{
            "type":"number",
            "description":"Value that uniquely identifies the component item to use as the substitute component in the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the component item to use as the substitute component in the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentItemPriority":{
            "type":"number",
            "description":"Value that indicates the priority associated with the component item to use as the substitute component in the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentItemQuantity":{
            "type":"number",
            "description":"Value that indicates the quantity of the substitute component being consumed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteComponentItemUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure associated with the substitute component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Option Dependent Resource Details V2

Type: array

Title: Option Dependent Resource Details V2

Details of resources used in operations that depend on the selection of one or more optional components, provided as input for supply chain planning activities.

Show Source

• Array of: object planInputs-BillOfResourcesV2-OptionDependentDetailsV2-item-response

{
    "title":"Option Dependent Resource Details V2",
    "type":"array",
    "description":"Details of resources used in operations that depend on the selection of one or more optional components, provided as input for supply chain planning activities.",
    "items":{
        "$ref":"#/components/schemas/planInputs-BillOfResourcesV2-OptionDependentDetailsV2-item-response"
    }
}

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."
        }
    }
}

Nested Schema : planInputs-BillOfResourcesV2-OptionDependentDetailsV2-item-response

Type: object

Show Source

• AssemblyItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the assembly item.
• AssemblyItemName: string
  Read Only: true

  Maximum Length: 255

  Name of the assembly item.
• BorId: integer
  Read Only: true

  Value that uniquely identifies the bill of resources.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationSequenceNumber: number
  Read Only: true

  Number that indicates the order for operations that are dependent on the choice of one or multiple optional components in the bill of resources.
• OptionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the optional component for the option dependent resource in the bill of resources.
• OptionMemberId: integer (int64)
  Read Only: true

  Value that uniquely identifies the end option item or class in the optional component lineage in the bill of resources.
• OptionMemberLineageNames: string
  Read Only: true

  Maximum Length: 4000

  Ordered list of names for the parent option items or classes of an optional component in the bill of resources.
• OptionMemberName: string
  Read Only: true

  Maximum Length: 4000

  Name of the end option item or class in the optional component lineage in the bill of resources.
• OptionMemberType: string
  Read Only: true

  Maximum Length: 4000

  Value that indicates whether the optional component in the bill of resources is an item or class. Contains one of the following values: 0 or 1. If 0, then the component is an option item. If 1, then the component is an option class. This attribute doesn't have a default value.
• OptionMemberUsageQuantity: number
  Read Only: true

  Value that indicates the quantity of the optional component being consumed in the bill of resources.
• Organization: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the organization associated with the item.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• ResourceCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the resource.
• ResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource.
• ResourceUsageQuantity: number
  Read Only: true

  Quantity of the resource being consumed.
• SourceOrganization: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the organization where the component or resource is defined.
• SourceOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the source organization.

{
    "type":"object",
    "properties":{
        "AssemblyItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assembly item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssemblyItemName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill of resources.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the order for operations that are dependent on the choice of one or multiple optional components in the bill of resources.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the optional component for the option dependent resource in the bill of resources.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptionMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the end option item or class in the optional component lineage in the bill of resources.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptionMemberLineageNames":{
            "maxLength":4000,
            "type":"string",
            "description":"Ordered list of names for the parent option items or classes of an optional component in the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionMemberName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the end option item or class in the optional component lineage in the bill of resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionMemberType":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that indicates whether the optional component in the bill of resources is an item or class. Contains one of the following values: 0 or 1. If 0, then the component is an option item. If 1, then the component is an option class. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionMemberUsageQuantity":{
            "type":"number",
            "description":"Value that indicates the quantity of the optional component being consumed in the bill of resources.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceUsageQuantity":{
            "type":"number",
            "description":"Quantity of the resource being consumed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization where the component or resource is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top