REST API for Oracle Field Service Cloud Service

Get inventory types

get

/rest/ofscMetadata/v1/inventoryTypes

The operation retrieves a collection of inventory types.

Configuration: You must grant permissions to the Core API and must at least set Read-Only access to the Inventory type entity in the Configuration, Applications (API permissions) screen.

Request

Query Parameters

language: string
The translation language code.
Based on the value of this parameter, the translations for the name and unit of measurement of the inventory type is returned in the 'name' and 'unitOfMeasurement' fields.
- If the value is specified, then the translated value is returned in the 'name' and 'unitOfMeasurement' fields, and the 'translations' field is not returned in the response.
- If translation for the specified language does not exist, then the value in the 'name' and 'unitOfMeasurement' fields is returned in English.
- If the value is not specified, then the 'translations' field is returned in the response and contains the translations to every language in the system.
For the list of supported language codes, see Supported Language Codes.
limit: integer

The number of inventory type records 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
application/schema+json

200 Response

This section describes the 200 status response for this operation.

Root Schema : InventoryTypes

Type: object

An array of the inventory type records in the collection.

Show Source

hasMore: boolean

Contains one of the following values: true or false.
If true, then there are more results that can be retrieved with successive paging requests.
If false or if the value is not present, then there are no more results or this is the final page. The default value is true.
items: array items
limit: integer

The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.
offset: integer

The offset value specified in the request.
totalResults: integer

The total number of the inventory type records in the collection.

{
    "description":"An array of the inventory type records in the collection.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InventoryType"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of the inventory type records in the collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false.<p>If true, then there are more results that can be retrieved with successive paging requests.</p><p>If false or if the value is not present, then there are no more results or this is the final page. The default value is true.</p>"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100."
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Inventory Type

Title: Inventory Type

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

Nested Schema : Inventory Type

Type: object

Title: Inventory Type

Show Source

active(required): boolean

Title: Active

Indicates whether the inventory type is valid for creating an inventory. If the value is true, then the inventory type is listed as a possible value in the 'Inventory Type' drop-down list in Manage or Mobility apps while creating an inventory. If the value is false, then the inventory type is not listed as a value in the drop-down list.
label(required): string

Title: Label

Inventory type label.
modelProperty: string

Title: Model Property

Label of an inventory property which is used to identify model of this inventory.
name(required): string

Title: Name

Minimum Length: 1

Maximum Length: 40

The translation for the name of the inventory type. If the value of the language parameter is specified, then the name is provided in the specified language. If the value is not specified, then the name is provided in English. Minimum Length: 1, Maximum Length: 40.
nonSerialized(required): boolean

Title: Non Serialized

Indicates whether the inventory is serialized. If the value is true, then the inventory is serialized, that is, it has a serial number. If the value is false, then the inventory is non-serialized, that is, it doesn't have a serial number.
quantityPrecision: integer

Title: Quantity precision

Number of digits after decimal point of the quantity for non-serialized inventory . '0' value means that the quantity doesn't have a fractional part.
translations(required): array Translations

Title: Translations

The list of translations associated with the name and unit of measurement of the inventory type. The list is only returned if the language parameter is not specified in the request. language: string - The language code of the translated text. The code in the response is two characters long. For example, 'en', 'es'.
unitOfMeasurement: string

Title: Unit Of Measurement

The translation for the unit of measurement of the inventory type. If the value of the language parameter is specified, then the unit of measurement is provided the specified language. If the value is not specified, then the unit of measurement is provided in English. This attribute is used only for non-serialized inventory.

{
    "type":"object",
    "title":"Inventory Type",
    "properties":{
        "label":{
            "type":"string",
            "title":"Label",
            "description":"Inventory type label."
        },
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Name",
            "description":"The translation for the name of the inventory type. If the value of the language parameter is specified, then the name is provided in the specified language. If the value is not specified, then the name is provided in English. Minimum Length: 1, Maximum Length: 40."
        },
        "unitOfMeasurement":{
            "type":"string",
            "title":"Unit Of Measurement",
            "description":"The translation for the unit of measurement of the inventory type. If the value of the language parameter is specified, then the unit of measurement is provided the specified language. If the value is not specified, then the unit of measurement is provided in English. This attribute is used only for non-serialized inventory."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Indicates whether the inventory type is valid for creating an inventory. If the value is true, then the inventory type is listed as a possible value in the 'Inventory Type' drop-down list in Manage or Mobility apps while creating an inventory. If the value is false, then the inventory type is not listed as a value in the drop-down list."
        },
        "nonSerialized":{
            "type":"boolean",
            "title":"Non Serialized",
            "description":"Indicates whether the inventory is serialized. If the value is true, then the inventory is serialized, that is, it has a serial number. If the value is false, then the inventory is non-serialized, that is, it doesn't have a serial number."
        },
        "modelProperty":{
            "type":"string",
            "title":"Model Property",
            "description":"Label of an inventory property which is used to identify model of this inventory."
        },
        "quantityPrecision":{
            "type":"integer",
            "title":"Quantity precision",
            "description":"Number of digits after decimal point of the quantity for non-serialized inventory . '0' value means that the quantity doesn't have a fractional part."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TranslationInvType"
            },
            "title":"Translations",
            "description":"The list of translations associated with the name and unit of measurement of the inventory type. The list is only returned if the language parameter is not specified in the request.\nlanguage: string - The language code of the translated text. The code in the response is two characters long. For example, 'en', 'es'."
        }
    },
    "required":[
        "label",
        "name",
        "active",
        "nonSerialized",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The list of translations associated with the name and unit of measurement of the inventory type. The list is only returned if the language parameter is not specified in the request. language: string - The language code of the translated text. The code in the response is two characters long. For example, 'en', 'es'.

Show Source

Array of: object TranslationInvType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TranslationInvType"
    },
    "title":"Translations",
    "description":"The list of translations associated with the name and unit of measurement of the inventory type. The list is only returned if the language parameter is not specified in the request.\nlanguage: string - The language code of the translated text. The code in the response is two characters long. For example, 'en', 'es'."
}

Nested Schema : TranslationInvType

Type: object

Show Source

language(required): string

The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').
See Supported Language Codes to view the values that are supported.
languageISO: string

The ISO language code. For example, 'en-US'.
name(required): string

The specified name of the property translated to the language code available in the application.
unitOfMeasurement: string

Title: Unit Of Measurement

The translation for the unit of measurement of the inventory type. This attribute is used only for non-serialized inventory.

{
    "properties":{
        "language":{
            "description":"The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').<p>See <a href='OFSC_Supported_Language_Codes.html'>Supported Language Codes</a> to view the values that are supported.</p> ",
            "type":"string"
        },
        "languageISO":{
            "description":"The ISO language code. For example, 'en-US'.",
            "type":"string"
        },
        "unitOfMeasurement":{
            "type":"string",
            "title":"Unit Of Measurement",
            "description":"The translation for the unit of measurement of the inventory type. This attribute is used only for non-serialized inventory."
        },
        "name":{
            "description":"The specified name of the property translated to the language code available in the application.",
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

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"
    ]
}

Examples

Example 1

The following example shows how to obtain a collection of inventory types by submitting a GET request on the REST resource using cURL.

Use the cURL command with the following syntax:

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' \
     -H 'Accept: application/json' \
     'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?limit=2&offset=2'

Response Header Example

The following shows an example of the response header:

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 24 Jan 2018 12:28:18 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Response Body Example

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

{
    "hasMore": true,
    "totalResults": 10,
    "limit": 2,
    "offset": 2,
    "items": [
        {
            "label": "DT",
            "name": "Digital Telephony",
            "active": true,
            "nonSerialized": false,
            "modelProperty": "inventory_model",
            "translations": [
                {
                    "language":"en",
                    "name": "Digital Telephony",
                    "languageISO": "en-US"
                },
                {
                    "language":"es",
                    "name": "Telefonía digital",
                    "languageISO": "es-ES"
                }
            ],
            "links": [
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/inventoryTypes"
                }
            ]
        },
        {
            "label": "EC",
            "name": "Ethernet Cable",
            "unitOfMeasurement": "ft",
            "active": true,
            "nonSerialized": true,
            "modelProperty": "inventory_model",
            "translations": [
                {
                    "language":"en",
                    "name": "Ethernet Cable",
                    "unitOfMeasurement": "ft",
                    "languageISO": "en-US"
                },
                {
                    "language":"es",
                    "name": "Cable Ethernet",
                    "unitOfMeasurement": "m",
                    "languageISO": "es-ES"
                }
            ],
            "links": [
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/inventoryTypes"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?limit=2&offset=2"
        },
        {
            "rel": "prev",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?limit=2&offset=0"
        },
        {
            "rel": "next",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?limit=2&offset=4"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/inventoryTypes"
        }
    ]
}

Example 2

The following example shows how to obtain a collection of inventory types by using the language parameter with the GET request on the REST resource.

Use the cURL command with the following syntax:

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' \
     -H 'Accept: application/json' \
     'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?language=en-US&limit=2&offset=2'

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 24 Jan 2018 12:28:18 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Response Body Example

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

{
    "hasMore": true,
    "totalResults": 10,
    "limit": 2,
    "offset": 2,
    "items": [
        {
            "label": "DT",
            "name": "Digital Telephony",
            "active": true,
            "nonSerialized": false,
            "modelProperty": "inventory_model",
            "links": [
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/inventoryTypes"
                }
            ]
        },
        {
            "label": "EC",
            "name": "Ethernet Cable",
            "unitOfMeasurement": "ft",
            "active": true,
            "nonSerialized": true,
            "modelProperty": "inventory_model",
            "links": [
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/inventoryTypes"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?limit=2&offset=2"
        },
        {
            "rel": "prev",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?limit=2&offset=0"
        },
        {
            "rel": "next",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/inventoryTypes/?limit=2&offset=4"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/inventoryTypes"
        }
    ]
}