'catalog' Element of 'upload_catalog' Request

The 'catalog' element of the 'search_catalog' response consists of the following fields:

'catalog' element parameters

Name

Type

Description

label

string

technical name of the catalog

language

string

language of the catalog

name

string

name of the catalog to be displayed in GUI

items_count

int

number of items in the catalog with 'weight' greater than 0

field_schemas

array

array of 'field_schema' elements, each containing one of the fields to be set for the catalog

type_schemas

array

array of 'type_schema' elements, each containing an item type and, optionally may also contain the inventory type corresponding to such item type

  • 'field_schema' Element of 'search_catalog' Request

The 'field_schema' element of the 'search_catalog' response consists of the following fields:

'field_schema' element parameters

Name

Type

Description

label

string

field identifier

name

string

field name to be displayed in GUI

property_label

string

identifier of the inventory property to transfer data from the catalog to the inventory form in Oracle Field Service

searchable

bool

parameter defining whether the field is used for search

default value: 0 (non-searchable)

preview

bool

parameter defining whether the field is cached in offline mode and displayed in the search results in offline

default value: 0 (included in search results only in the online mode)

  • 'type_schema' Element of 'search_catalog' Request

The 'type_schema' element of the 'search_catalog' response consists of the following fields:

'type_schema' element parameters

Name

Type

Description

item_type

string

item type according to the catalog

inventory_type

string

inventory type according to settings in Oracle Field Service