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.
Certifications
OData feed entity set: rc.Certifications
Column | Required | Description | Relates to |
CertificationId | Yes | Unique ID of Certification | - |
Code | Yes | - | - |
Description | Yes | - | - |
RenewValue | Yes | Integer indicating how many renewal units | - |
RenewUnitOfTime | Yes | Y(ear), M(onth), D(ay) | - |
Notes | No | - | - |
EmployeeCertifications
OData feed entity set: rc.EmployeeCertifications
Column | Required | Description | Relates to |
CertificationId | Yes | The Certification related to this Employee | Certifications |
EmployeeEntityId | Yes | The Employee related to this Certification | Entities |
CertifiedOn | No | Date of Certification | - |
ExpiresOn | No | Date Certification Expires | - |
EmployeeTypes
OData feed entity set: rc.EmployeeTypes
Column | Required | Description | Relates to |
EmployeeTypeId | Yes | The unique id for the employee type | - |
EmployeeTypeNumber | Yes | The user defined identifier of the employee type. (Not necessarily a numeric value) | - |
Description | Yes | Description of the type of employee being defined. | - |
IsDeleted | Yes | Identifies if a employee type has been marked as deleted. (0 - No, 1 - Yes) | - |
IsInactive | Yes | Identifies if a employee type has been marked as inactive (0 - No, 1 - Yes) | - |
CreatedById | Yes | User that created the record. | Entities |
CreatedOn | Yes | Date and time that the record was created. | - |
ModifiedById | Yes | User that last modified the record. | Entities |
ModifiedOn | Yes | Date and time that the record was modified. | - |
Entities
Entities are the people and places that assets can be assigned to. That is: employees, users, locations, and stock locations.
OData feed entity set: rc.Entities
Column | Required | Description | Relates to |
EntityId | Yes | The unique ID of this entity | - |
Type | Yes | 'E' for employees, 'L' for locations (including stock locations) | - |
Number | Yes | A shorthand string used to refer to this entity | - |
Description | Yes | A brief phrase describing this entity | - |
StockpointEntityId | Yes | The stock location this entity is associated with. This is equal to the EntityId if the entity is a stock location itself. | Entities |
SupervisorEntityId | No | The entity responsible for supervising this entity | Entities |
IsStockLocation | Yes | - | - |
Street1 | No | First line of the street address | - |
Street2 | No | Second line of the street address | - |
City | No | City | - |
State | No | - | - |
Zip | No | - | - |
Country | No | - | - |
Phone1 | No | - | - |
Phone2 | No | - | - |
FirstName | No | First name of employee | - |
LastName | No | Last name of employee | - |
No | Email address of employee | - | |
HireDate | No | Date employee was hired | - |
DepartmentId | No | - | - |
EmployeeTypeId | No | - | - |
TerminationDate | No | Date employee was terminated | - |
InactiveDate | No | Date employee was changed to inactive | - |
IsInactive | No | Active = 0, Inactive = 1 | - |
IsDoNotTransfer | No | - | - |
DoNotTransferReason | No | Reason why entity cannot be recipient of transfer | - |
IsDeleted | No | Identifies if a employee type has been marked as deleted. (0 - No, 1 - Yes) | - |
DefaultCostCenterId | No | The cost center identifier that is used if nothing else is specified | CostCenters |
DefaultCostCodeId | No | - | - |
ParentId | No | The parent entity in the organization. | Entities |
RolePermissions
Contains a record for each user role detailing its available permissions.
OData feed entity set: rc.RolePermissions
Column | Required | Description | Relates to |
RoleId | Yes | The unique ID of this role | Roles |
RoleDescription | Yes | The Role's description | - |
Permission | Yes | The permission description | - |
CanView | Yes | Permission to view records | - |
CanAdd | Yes | Permission to add new records | - |
CanEdit | Yes | Permission to edit existing records | - |
CanDelete | Yes | Permission to delete a record | - |
CanExecute | Yes | Permission to execute actions | - |
Roles
Contains a record for each user role.
OData feed entity set: rc.Roles
Column | Required | Description | Relates to |
RoleId | Yes | The unique ID of this role | - |
Description | Yes | The Role's description | - |
UserPermissions
Contains a record for each permission assignment for each ToolWatch user.
OData feed entity set: rc.UserPermissions
Column | Required | Description | Relates to |
EntityId | Yes | The unique ID of the user entity | Entities |
EntityEmail | No | - | - |
Permission | Yes | The permission description | - |
CanView | Yes | Permission to view records | - |
CanAdd | Yes | Permission to add new records | - |
CanEdit | Yes | Permission to edit existing records | - |
CanDelete | Yes | Permission to delete a record | - |
CanExecute | Yes | Permission to execute actions | - |
UserRoles
Contains a record for each role assigned to ToolWatch users.
OData feed entity set: rc.UserRoles
Column | Required | Description | Relates to |
EntityId | Yes | The unique ID of the user entity | Entities |
EntityEmail | No | - | - |
RoleId | Yes | The unique ID of this role | Roles |
RoleDescription | Yes | The description of the role | - |
Users
Contains a record for each ToolWatch user.
OData feed entity set: rc.Users
Column | Required | Description | Relates to |
EntityId | Yes | The unique ID of the entity | Entities |
Yes | The email (username) of this user | - |
Visibility
OData feed entity set: rc.Visibility
Column | Required | Description | Relates to |
StockLocationId | Yes | This is the identifier of the stock location that the visibility is set for. | Entities |
ListItemId | Yes | This is the foreign key to one of the list types. It could be an entity, cost center, cost code, etc. | - |