Jump to

• Request
• Response

Update an operation material

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrderOperations/{workOrderOperationsUniqID}/child/operationMaterials/{operationMaterialsUniqID}

Request

Path Parameters

• PlanId(required): integer(int64)
  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=
• operationMaterialsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, WorkOrderOperationId, ResourceSequenceNumber and InventoryItemId ---for the Operation Materials resource and used to uniquely identify an instance of Operation Materials. The client should not generate the hash key value. Instead, the client should query on the Operation Materials collection resource with a filter on the primary key values in order to navigate to a specific instance of Operation Materials.
  
  For example: operationMaterials?q=PlanId=<value1>;WorkOrderOperationId=<value2>;ResourceSequenceNumber=<value3>;InventoryItemId=<value4>
• workOrderOperationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, WorkOrderOperationId and ResourceSequenceNumber ---for the Work Order Operations resource and used to uniquely identify an instance of Work Order Operations. The client should not generate the hash key value. Instead, the client should query on the Work Order Operations collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Order Operations.
  
  For example: workOrderOperations?q=PlanId=<value1>;WorkOrderOperationId=<value2>;ResourceSequenceNumber=<value3>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• IssuedQuantity: number
  Quantity issued on the operation.
• MaterialSequenceNumber: number
  Number that indicates the sequence for a component item for a work order operation.
• MaterialType: string
  Maximum Length: 30

  Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ProducedQuantity: number
  Quantity issued so far, since partial issues are possible.
• Quantity: number
  Quantity of the material either consumed in the operation or produced from the operation.
• RemainingQuantity: number
  Quantity that's remaining.
• ResourceSequenceNumber: integer
  Number that identifies the resource sequence of the operation material.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
• WorkOrderOperationMaterialId: integer (int64)
  Value that uniquely identifies the component item for a work order operation.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component item for a work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MaterialType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item.",
            "nullable":false
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key of the work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProducedQuantity":{
            "type":"number",
            "description":"Quantity issued so far, since partial issues are possible.",
            "nullable":true
        },
        "IssuedQuantity":{
            "type":"number",
            "description":"Quantity issued on the operation.",
            "nullable":true
        },
        "RemainingQuantity":{
            "type":"number",
            "description":"Quantity that's remaining.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceSequenceNumber":{
            "type":"integer",
            "description":"Number that identifies the resource sequence of the operation material.",
            "nullable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MaterialSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the sequence for a component item for a work order operation.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the material either consumed in the operation or produced from the operation.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : productionSchedulingPlans-workOrderOperations-operationMaterials-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the record.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• IssuedQuantity: number
  Quantity issued on the operation.
• ItemCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialSequenceNumber: number
  Number that indicates the sequence for a component item for a work order operation.
• MaterialType: string
  Maximum Length: 30

  Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ProducedQuantity: number
  Quantity issued so far, since partial issues are possible.
• Quantity: number
  Quantity of the material either consumed in the operation or produced from the operation.
• RemainingQuantity: number
  Quantity that's remaining.
• ResourceSequenceNumber: integer
  Number that identifies the resource sequence of the operation material.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the unit of measure.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
• WorkOrderOperationMaterialId: integer (int64)
  Value that uniquely identifies the component item for a work order operation.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component item for a work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key of the work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemainingQuantity":{
            "type":"number",
            "description":"Quantity that's remaining.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceSequenceNumber":{
            "type":"integer",
            "description":"Number that identifies the resource sequence of the operation material.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the material either consumed in the operation or produced from the operation.",
            "nullable":false,
            "x-queryable":true
        },
        "MaterialType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item.",
            "nullable":false,
            "x-queryable":true
        },
        "ProducedQuantity":{
            "type":"number",
            "description":"Quantity issued so far, since partial issues are possible.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuedQuantity":{
            "type":"number",
            "description":"Quantity issued on the operation.",
            "nullable":true,
            "x-queryable":true
        },
        "MaterialSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the sequence for a component item for a work order operation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "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."
        }
    }
}

Back to Top