Get resource inventories

get

/rest/ofscCore/v1/resources/{resourceId}/inventories

This operation retrieves the resource inventories for the specified resource.

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 : Resource Inventories
Type: object
Title: Resource Inventories
The collection of resource inventories.
Show Source
Nested Schema : Resource Inventories
Type: array
Title: Resource Inventories
An array of resource inventories.
Show Source
Nested Schema : Inventory
Type: object
Title: Inventory
The inventory that can be installed or deinstalled 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 resource inventories for resources by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscCore/v1/resources/33035/inventories HTTP/1.0
Authorization: Basic c29hcEB5YW1hdG86MQ==
Host: <instance_name>.etadirect.com    Accept: */*

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Mon, 06 Jul 2015 13:20:14 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": 20997542,
                "status": "provider",
                "inventoryType": "TV",
                "serialNumber": "PLBJ1C3AB",
                "quantity": 1,
                "resourceId": "44035"
            },
            {
                "inventoryId": 20996913,
                "status": "provider",
                "inventoryType": "DT",
                "serialNumber": "58NBME39T065517",
                "quantity": 1,
                "resourceId": "44035"
            },
            {
                "inventoryId": 20996675,
                "status": "provider",
                "inventoryType": "DT",
                "serialNumber": "HRSC63602",
                "quantity": 1,
                "resourceId": "44035"
            },
            {
                "inventoryId": 20997195,
                "status": "provider",
                "inventoryType": "AT",
                "serialNumber": "PMUD106F8",
                "quantity": 1,
                "resourceId": "44035"
            }
        ],
        "total": 4,
        "links": [
            {
                "rel": "canonical",
                "href": "https://<instance_name>.etadirect.com/wwwroot-master/rest/ofscCore/v1/resources/44035/inventories"
            },
            {
                "rel": "describedby",
                "href": "https://<instance_name>.etadirect.com/wwwroot-master/rest/ofscCore/v1/metadata-catalog/resources"
            }
        ]
}
Back to Top