Jump to

• Request
• Response

Update one bill of resource

patch

/fscmRestApi/resources/11.13.18.05/salesAndOperationsPlans/{PlanId}/child/BillOfResourcesV2/{DerivedBorId}

Request

Path Parameters

• DerivedBorId(required): string
  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=
• PlanId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssemblyDescription: string
  Maximum Length: 240

  Description of the assembly item.
• AssemblyItemId: integer (int64)
  Value that uniquely identifies the assembly item.
• AssemblyItemLevel: string
  Maximum Length: 8

  Data load level of the item being produced. Valid values are Item and Category.
• AssemblyItemName: string
  Maximum Length: 300

  Name of the assembly item.
• AssemblyQuantity: number
  Default Value: 0

  Quantity of the item being produced.
• AssemblyUOM: string
  Maximum Length: 4000

  Planning unit of measure of the assembly item.
• BorId: integer (int64)
  Value that uniquely identifies the bill of resources.
• CatalogId: integer (int64)
  Value that uniquely identifies the catalog.
• CatalogName: string
  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)
  Value that uniquely identifies the category.
• CategoryName: string
  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
  Maximum Length: 3

  Planning unit of measure of the category.
• ComponentDescription: string
  Maximum Length: 240

  Description of the component item.
• ComponentItemId: integer (int64)
  Value that uniquely identifies the component item.
• ComponentItemName: string
  Maximum Length: 300

  Name of the component item.
• ComponentUsageQuantity: number
  Title: Usage Quantity

  Default Value: 0

  Quantity of the item being consumed.
• ConsumptionType: string
  Maximum Length: 72

  Type of consumption. This attribute indicates whether an item or resource is being consumed. Valid values are Item and Resource.
• DerivedBorId: string
  Maximum Length: 18

  Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.
• EffectiveEndDate: string (date)
  Date when the component item or resource is no longer available.
• EffectiveStartDate: string (date)
  Date when the component item or resource is available.
• NewPlanId: integer
  Default Value: -1

  Most recent value that uniquely identifies the plan.
• Organization: string
  Maximum Length: 4000

  Abbreviation that identifies the organization associated with the item.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• ResourceCode: string
  Maximum Length: 40

  Abbreviation that identifies the resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource.
• ResourceUOM: string
  Maximum Length: 4000

  Unit of measure associated with the resource.
• ResourceUsageQuantity: number
  Default Value: 0

  Quantity of the resource being consumed.
• WorkCenterCode: string
  Maximum Length: 120

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center.

{
    "type":"object",
    "properties":{
        "AssemblyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the assembly item.",
            "nullable":true
        },
        "AssemblyItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assembly item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssemblyItemLevel":{
            "maxLength":8,
            "type":"string",
            "description":"Data load level of the item being produced. Valid values are Item and Category.",
            "nullable":true
        },
        "AssemblyItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the assembly item.",
            "nullable":true
        },
        "AssemblyQuantity":{
            "type":"number",
            "description":"Quantity of the item being produced.",
            "nullable":false,
            "default":0
        },
        "AssemblyUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Planning unit of measure of the assembly item.",
            "nullable":true
        },
        "BorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill of resources.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "CategoryUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Planning unit of measure of the category.",
            "nullable":true
        },
        "ComponentDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the component item.",
            "nullable":true
        },
        "ComponentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ComponentItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the component item.",
            "nullable":true
        },
        "ComponentUsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"Quantity of the item being consumed.",
            "nullable":false,
            "default":0,
            "x-hints":{
                "help":{
                    "instruction":"Usage Quantity"
                }
            }
        },
        "ConsumptionType":{
            "maxLength":72,
            "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
        },
        "DerivedBorId":{
            "maxLength":18,
            "type":"string",
            "description":"Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date when the component item or resource is no longer available.",
            "format":"date",
            "nullable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date when the component item or resource is available.",
            "format":"date",
            "nullable":true
        },
        "NewPlanId":{
            "type":"integer",
            "description":"Most recent value that uniquely identifies the plan.",
            "nullable":false,
            "default":-1
        },
        "Organization":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the item.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceCode":{
            "maxLength":40,
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true
        },
        "ResourceUsageQuantity":{
            "type":"number",
            "description":"Quantity of the resource being consumed.",
            "nullable":false,
            "default":0
        },
        "WorkCenterCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : salesAndOperationsPlans-BillOfResourcesV2-item-response

Type: object

Show Source

• AssemblyDescription: string
  Maximum Length: 240

  Description of the assembly item.
• AssemblyItemId: integer (int64)
  Value that uniquely identifies the assembly item.
• AssemblyItemLevel: string
  Maximum Length: 8

  Data load level of the item being produced. Valid values are Item and Category.
• AssemblyItemName: string
  Maximum Length: 300

  Name of the assembly item.
• AssemblyQuantity: number
  Default Value: 0

  Quantity of the item being produced.
• AssemblyUOM: string
  Maximum Length: 4000

  Planning unit of measure of the assembly item.
• BorId: integer (int64)
  Value that uniquely identifies the bill of resources.
• CatalogId: integer (int64)
  Value that uniquely identifies the catalog.
• CatalogName: string
  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)
  Value that uniquely identifies the category.
• CategoryName: string
  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
  Maximum Length: 3

  Planning unit of measure of the category.
• ComponentDescription: string
  Maximum Length: 240

  Description of the component item.
• ComponentItemId: integer (int64)
  Value that uniquely identifies the component item.
• ComponentItemName: string
  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
  Title: Usage Quantity

  Default Value: 0

  Quantity of the item being consumed.
• ConsumptionType: string
  Maximum Length: 72

  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
  Maximum Length: 18

  Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.
• EffectiveEndDate: string (date)
  Date when the component item or resource is no longer available.
• EffectiveStartDate: string (date)
  Date when the component item or resource is available.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewPlanId: integer
  Default Value: -1

  Most recent value that uniquely identifies the plan.
• Organization: string
  Maximum Length: 4000

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

  Maximum Length: 240

  Name of the organization for the assembly item.
• ResourceCode: string
  Maximum Length: 40

  Abbreviation that identifies the resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource.
• ResourceUOM: string
  Maximum Length: 4000

  Unit of measure associated with the resource.
• ResourceUsageQuantity: number
  Default Value: 0

  Quantity of the resource being consumed.
• WorkCenterCode: string
  Maximum Length: 120

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center.

{
    "type":"object",
    "properties":{
        "AssemblyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the assembly item.",
            "nullable":true,
            "x-queryable":true
        },
        "AssemblyItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assembly item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssemblyItemLevel":{
            "maxLength":8,
            "type":"string",
            "description":"Data load level of the item being produced. Valid values are Item and Category.",
            "nullable":true,
            "x-queryable":true
        },
        "AssemblyItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the assembly item.",
            "nullable":true,
            "x-queryable":true
        },
        "AssemblyQuantity":{
            "type":"number",
            "description":"Quantity of the item being produced.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "AssemblyUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Planning unit of measure of the assembly item.",
            "nullable":true,
            "x-queryable":true
        },
        "BorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill of resources.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":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,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "format":"int64",
            "nullable":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,
            "x-queryable":true
        },
        "CategoryUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Planning unit of measure of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the component item.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ComponentItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the component item.",
            "nullable":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":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"Quantity of the item being consumed.",
            "nullable":false,
            "default":0,
            "x-hints":{
                "help":{
                    "instruction":"Usage Quantity"
                }
            },
            "x-queryable":true
        },
        "ConsumptionType":{
            "maxLength":72,
            "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,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the bill of resources.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the bill of resources.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedBorId":{
            "maxLength":18,
            "type":"string",
            "description":"Unique identifier for a row in the bill of resources when alternate resources or substitute components are present.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date when the component item or resource is no longer available.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date when the component item or resource is available.",
            "format":"date",
            "nullable":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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the bill of resources.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewPlanId":{
            "type":"integer",
            "description":"Most recent value that uniquely identifies the plan.",
            "nullable":false,
            "default":-1,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "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,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceUOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceUsageQuantity":{
            "type":"number",
            "description":"Quantity of the resource being consumed.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center.",
            "format":"int64",
            "nullable":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 : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

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

  The kind of the related resource.
• name: string
  Title: name

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

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

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

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

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Back to Top