Create updates
/fscmRestApi/resources/11.13.18.05/materialStatusUpdates
Request
-
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.
- application/json
object
-
ErrorCode: string
Value that indicates the error to use if an error occurs. Contains a value or is empty. Value: error code from the request. Empty: the request was successful.
-
ErrorExplanation: string
Name of the error message to use if an error occurs. Contains a value or is empty. Value: is the error message from the request. Empty: if the request was successful.
-
InventoryItemId: integer
Value that uniquely identifies the inventory item.
-
ItemNumber: string
Inventory item number.
-
LocatorId: integer
Value that uniquely identifies the locator.
-
LotNumber: string
Item lot number.
-
MaterialStatusId: integer
Value that uniquely identifies the material status.
-
OrganizationCode: string
Abbreviation that identifies the organization.
-
OrganizationId: integer
Value that uniquely identifies the organization.
-
Result: string
Indicates whether or not the request was successfully completed. Contains one of the following values: SUCCESS or ERROR. If SUCCESS, then the request is successful. If ERROR, then the request resulted in an error. There is no default value for the attribute.
-
SerialNumber: string
Serial number.
-
SubinventoryCode: string
Abbreviation that identifies the subinventory.
-
UpdateLevel: string
Value that indicates the level to use when updating the material status. Valid values include Subinventory, Locator, Lot, and SerialNumber. There is no default value for the attribute.
Response
- application/json
Default Response
-
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.
object
-
ErrorCode: string
Value that indicates the error to use if an error occurs. Contains a value or is empty. Value: error code from the request. Empty: the request was successful.
-
ErrorExplanation: string
Name of the error message to use if an error occurs. Contains a value or is empty. Value: is the error message from the request. Empty: if the request was successful.
-
InventoryItemId: integer
Value that uniquely identifies the inventory item.
-
ItemNumber: string
Inventory item number.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
Value that uniquely identifies the locator.
-
LotNumber: string
Item lot number.
-
MaterialStatusId: integer
Value that uniquely identifies the material status.
-
OrganizationCode: string
Abbreviation that identifies the organization.
-
OrganizationId: integer
Value that uniquely identifies the organization.
-
Result: string
Indicates whether or not the request was successfully completed. Contains one of the following values: SUCCESS or ERROR. If SUCCESS, then the request is successful. If ERROR, then the request resulted in an error. There is no default value for the attribute.
-
SerialNumber: string
Serial number.
-
SubinventoryCode: string
Abbreviation that identifies the subinventory.
-
UpdateLevel: string
Value that indicates the level to use when updating the material status. Valid values include Subinventory, Locator, Lot, and SerialNumber. There is no default value for the attribute.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update the material status for one lot of one item in one organization.
Example cURL Command
Use the following cURL command to submit a request on the REST resource. This example updates the material status for lot PSR_LT00130012, item PSR-INV-AS54889-000123, in organization M1:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/materialStatusUpdates"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{"OrganizationCode":"M1","ItemNumber":"PSR-INV-AS54889-000123","LotNumber":"PSR_LT00130012","MaterialStatusId":1,"UpdateLevel":"Lot"}
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ "ErrorExplanation" : null, "InventoryItemId" : null, "ItemNumber" : "PSR-INV-AS54889-000123", "LocatorId" : null, "LotNumber" : "PSR_LT00130012", "OrganizationCode" : "M1", "OrganizationId" : null, "Result" : "SUCCESS", "SerialNumber" : null, "SubinventoryCode" : null, "ErrorCode" : null, "MaterialStatusId" : 1, "UpdateLevel" : "Lot", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/materialStatusUpdates/99999", "name" : "materialStatusUpdates", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/materialStatusUpdates/99999", "name" : "materialStatusUpdates", "kind" : "item" } ] }"