Each entity below lists its OData feed entity set name and its columns, whether a value is required, a description, and the entity it relates to. For the terms used in these articles (tools, materials, assets, uniquely-tracked, and quantity-tracked), see Document Conventions in the ToolWatch OData API Overview.
Categories
OData feed entity set: rc.Categories
Column | Required | Description | Relates to |
CategoryId | Yes | The unique ID of this Category | - |
Number | Yes | A shorthand string used to refer to this Category | - |
Type | Yes | 'T' for tools, 'M' for materials, 'A' for templates | - |
Description | Yes | A brief phrase describing this Category | - |
IsDeleted | Yes | Indicates if this record has been deleted | - |
Classes
OData feed entity set: rc.Classes
Column | Required | Description | Relates to |
ClassId | Yes | - | - |
Number | Yes | A shorthand string used to refer to this class | - |
Description | Yes | A brief phrase describing this class | - |
IsDeleted | Yes | Indicates if this record has been deleted | - |
Departments
OData feed entity set: rc.Departments
Column | Required | Description | Relates to |
DepartmentId | Yes | The unique ID of this department | - |
Number | Yes | A shorthand string used to refer to this department | - |
Description | Yes | A brief phrase describing this department | - |
SupervisorEntityId | No | The entity responsible for supervising this department | Entities |
IsDeleted | Yes | Indicates if this record has been deleted | - |
Descriptions
OData feed entity set: rc.Descriptions
Column | Required | Description | Relates to |
DescriptionId | Yes | The unique ID of this unit of description | - |
Type | Yes | 'T' for unique tools, 'Q' for quantity tools, 'M' for materials. Other Types may be exposed in the future. | - |
Description | Yes | A brief phrase describing this description | - |
Manufacturers
OData feed entity set: rc.Manufacturers
Column | Required | Description | Relates to |
ManufacturerId | Yes | The unique ID of this manufacturer | - |
Number | Yes | A shorthand string used to refer to this manufacturer | - |
Description | Yes | A brief phrase describing this manufacturer (typically the name of the manufacturer) | - |
IsDeleted | Yes | Indicates if this record has been deleted | - |
StatusCodes
Status codes are one of the six attributes that are used to describe all assets (see InventoryKeys). They can be effectively used to distinguish between two groups of otherwise similar assets, such as New and Used. Status codes also are used to cause some assets to be treated differently. For example, if a status code has IsTransferProhibited set, then any asset given that status won't be able to change assignment.
OData feed entity set: rc.StatusCodes
Column | Required | Description | Relates to |
StatusCodeId | Yes | The unique ID of this status code | - |
Number | Yes | A shorthand string used to refer to this status code (e.g. BK) | - |
Description | Yes | A brief phrase describing this status code (e.g. Broken) | - |
IsTransferProhibited | Yes | If set then the user will be prevented from adding the associated asset to a transfer | - |
IsDeleted | Yes | Indicates if this record has been deleted | - |
UnitsOfMeasure
OData feed entity set: rc.UnitsOfMeasure
Column | Required | Description | Relates to |
UnitOfMeasureId | Yes | The unique ID of this unit of measure | - |
Number | Yes | A shorthand string used to refer to this unit (e.g. 'ft', 'lb') | - |
Description | Yes | A brief phrase describing this unit (e.g. 'feet', 'pounds') | - |