Update an inventory
patch
/rest/ofscCore/v1/inventories/{inventoryId}
This operation updates the properties of the specified inventory.
Request
Path Parameters
-
inventoryId(required): integer
The unique identifier of the inventory in Oracle Field Service.
Root Schema : inventory
Type:
Show Source
object
-
status:
string
Title:
Status
Allowed Values:[ "customer", "resource", "installed", "deinstalled" ]
The status of the specified inventory. For example, if 'customer' is returned, then it indicates that the inventory is at the customer's site.
Match All
Show Source
Nested Schema : Inventory
Type:
object
Title:
Inventory
The inventory that is installed or deinstalled at the customer's site during an activity.
Show Source
-
activityId:
integer
Title:
Activity ID
The activity ID to which the inventory is assigned.If the status for the inventory is set to resource, then the activity ID is not returned.
-
exchangedInventoryId:
integer
Title:
Exchanged Inventory ID
The inventory ID that is returned when the resource exchanges an inventory with another resource. -
inventoryId:
integer
Title:
Inventory ID
The unique identifier of the inventory in Oracle Field Service. -
inventoryType:
string
Title:
Inventory Type
The inventory type specified in the request. -
quantity:
number
Title:
Quantity
The quantity of inventory specified in the request. -
resourceId:
string
Title:
Resource ID
The resource ID to which the inventory is assigned or the resource ID to which the activity (that has the inventory assigned to it) is assigned. -
serialNumber:
string
Title:
Serial Number
The serial number specified in the request.
Response
Supported Media Types
- application/json
200 Response
This section describes the 200 status response for this operation.
Root Schema : inventory
Type:
Show Source
object
-
status:
string
Title:
Status
Allowed Values:[ "customer", "resource", "installed", "deinstalled" ]
The status of the specified inventory. For example, if 'customer' is returned, then it indicates that the inventory is at the customer's site.
Match All
Show Source
Nested Schema : Inventory
Type:
object
Title:
Inventory
The inventory that is installed or deinstalled at the customer's site during an activity.
Show Source
-
activityId:
integer
Title:
Activity ID
The activity ID to which the inventory is assigned.If the status for the inventory is set to resource, then the activity ID is not returned.
-
exchangedInventoryId:
integer
Title:
Exchanged Inventory ID
The inventory ID that is returned when the resource exchanges an inventory with another resource. -
inventoryId:
integer
Title:
Inventory ID
The unique identifier of the inventory in Oracle Field Service. -
inventoryType:
string
Title:
Inventory Type
The inventory type specified in the request. -
quantity:
number
Title:
Quantity
The quantity of inventory specified in the request. -
resourceId:
string
Title:
Resource ID
The resource ID to which the inventory is assigned or the resource ID to which the activity (that has the inventory assigned to it) is assigned. -
serialNumber:
string
Title:
Serial Number
The serial number specified in the request.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
detail:
string
The detailed description of this error.
-
status:
string
The HTTP status code of this error.
-
title(required):
string
The brief description of this error.
-
type(required):
string
The URL of the web page containing more details about this error.
Examples
The following example shows how to update inventory by submitting a PATCH request on the REST resource:
Example of Request Header
The following shows an example of the request header.
PATCH /rest/ofscCore/v1/inventories HTTP/1.0 Authorization: Basic c29hcEB5YW1hdG86MQ== Host: etadev1f Accept: */*
Example of Request Body
The following shows an example of the request body
{ "serialNumber": "testtest" }
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 201 Created Server: nginx/1.6.2 Date: Fri, 24 Jul 2015 08:35:48 GMT ContentType: application/json; charset=utf8 Connection: close
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "inventoryId": 21258546, "status": "provider", "inventoryType": "NORMAL", "serialNumber": "testtest", "quantity": 1, "resourceId": "44001", "links": [ { "rel": "canonical", "href": "https://etadev1f/rest/ofscCore/v1/inventories/21258546" }, { "rel": "describedby", "href": "https://etadev1f/rest/ofscCore/v1/metadatacatalog/inventories" } ] }