Get customer inventories

get

/rest/ofscCore/v1/activities/{activityId}/customerInventories

This operation retrieves a list of installed or deinstalled customer inventories assigned to the specified activity.

Request

Path Parameters
Query Parameters
  • 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.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : Customer Inventories
Type: object
Title: Customer Inventories
The collection of customer inventories assigned to the specified activity.
Show Source
Nested Schema : items
Type: array
Show Source
  • Inventory
    Title: Inventory
    The inventory that is installed or deinstalled at the customer's site during an activity.
Nested Schema : Inventory
Type: object
Title: Inventory
The inventory that is installed or deinstalled at the customer's site during an activity.
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to get customer 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>.etadirect.com/rest/ofscCore/v1/activities/4225269/customerInventories'

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.2.7
Date: Fri, 18 Mar 2016 02:19:57 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "inventoryId": 21258546,
            "status": "customer",
            "inventoryType": "EC",
            "serialNumber": "0005179112",
            "quantity": 20,
            "activityId": 4225269
        }
    ],
    "totalResults": 1,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscCore//v1/activities/4225269/customerInventories"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscCore//v1/metadata-catalog/activities"
        }
    ]
}
Back to Top