Jump to

• Request
• Response
• Examples

Get customer inventories

get

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

This operation retrieves a list of customer inventories assigned to 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.

Back to Top

Response

Supported Media Types

• application/json

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

• items: array items

{
    "type":"object",
    "title":"Customer Inventories",
    "description":"The collection of customer inventories assigned to the specified activity.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/inventory"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object inventory

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/inventory"
    }
}

Nested Schema : inventory

Type: object

Show Source

• 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.

{
    "allOf":[
        {
            "$ref":"#/definitions/inventoryWithoutStatus"
        }
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "customer",
                "resource",
                "installed",
                "deinstalled"
            ],
            "description":"The status of the specified inventory. For example, if 'customer' is returned, then it indicates that the inventory is at the customer's site.",
            "title":"Status"
        }
    }
}

Match All

Show Source

• object Inventory
  Title: Inventory

  The inventory that is installed or deinstalled at the customer's site during an activity.

{
    "allOf":[
        {
            "$ref":"#/definitions/inventoryWithoutStatus"
        }
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "customer",
                "resource",
                "installed",
                "deinstalled"
            ],
            "description":"The status of the specified inventory. For example, if 'customer' is returned, then it indicates that the inventory is at the customer's site.",
            "title":"Status"
        }
    }
}

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.

{
    "title":"Inventory",
    "description":"The inventory that is installed or deinstalled at the customer's site during an activity.",
    "type":"object",
    "properties":{
        "resourceId":{
            "type":"string",
            "description":"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.",
            "title":"Resource ID"
        },
        "serialNumber":{
            "type":"string",
            "description":"The serial number specified in the request.",
            "title":"Serial Number"
        },
        "exchangedInventoryId":{
            "type":"integer",
            "description":"The inventory ID that is returned when the resource exchanges an inventory with another resource. ",
            "title":"Exchanged Inventory ID"
        },
        "quantity":{
            "x-nullable":true,
            "type":"number",
            "description":"The quantity of inventory specified in the request.",
            "title":"Quantity"
        },
        "inventoryType":{
            "x-nullable":true,
            "type":"string",
            "description":"The inventory type specified in the request.",
            "title":"Inventory Type"
        },
        "inventoryId":{
            "type":"integer",
            "description":"The unique identifier of the inventory in Oracle Field Service.",
            "title":"Inventory ID"
        },
        "activityId":{
            "type":"integer",
            "description":"The activity ID to which the inventory is assigned. <p>If the status for the inventory is set to resource, then the activity ID is not returned.</p>",
            "title":"Activity ID"
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• 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.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

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>.fs.ocs.oraclecloud.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>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/activities/4225269/customerInventories"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/metadata-catalog/activities"
        }
    ]
}

Back to Top