Get installed inventories
get
/rest/ofscCore/v1/activities/{activityId}/installedInventories
This operation retrieves a list of installed inventories for the specified activity.
Request
Path Parameters
-
activityId(required): integer
The unique identifier of the activity in Oracle Field Service.
Query Parameters
-
limit: integer
The number of items to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
-
offset: integer
The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
Response
Supported Media Types
- application/json
200 Response
This section describes the 200 status response for this operation.
Root Schema : Customer Inventories
Type:
object
Title:
Customer Inventories
The collection of installed inventories assigned to the specified activity.
Show Source
Nested 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 get installed inventories of an activity by submitting a GET request on the REST resource using cURL.
curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -H 'Accept: application/json' 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/activities/4225372/installedInventories'
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Server: nginx/1.6.2 Date: Wed, 31 Aug 2016 13:38:53 GMT Content-Type: application/json; charset=utf-8 Connection: close Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, DELETE, PATCH Access-Control-Allow-Headers: DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "totalResults": 1, "limit": 10, "offset": 0, "items": [ { "inventoryId": 21258546, "inventoryType": "NORMAL", "quantity": 1, "resourceId": "33011", "activityId": 4225371 } ], "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/activities/4225372/installedInventories" }, { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/metadata-catalog/activities" } ] }