Jump to

• Request
• Response

Get an inventory type

get

/rest/ofscMetadata/v1/inventoryTypes/{label}

This operation retrieves the details of the specified inventory type.

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 255

  The unique identifier of the inventory type.

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.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

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

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