Resources
Overview
Individuals, crews, or assets that can be scheduled to perform work.
System fields
System fields are read-only fields found on most objects. These fields are automatically updated during API operations. To learn more see System Fields.
Standard fields
| Field Name | Details | Required |
|---|---|---|
| Category | Type Picklist Description A descriptor that allows for differentiating between resource groups. Valid values are: - Customer Service - Installation Technician - Electrician Custom valuesThe values for this field may be modified via the Skedulo web app or via the Skedulo REST API. |
No |
| CountryCode | Type Picklist Description The country code associated with the Resource’s ‘mobile phone’ number. Valid values are: - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BR - BT - BV - BW - BY - BZ - CA - CC - CF - CH - CI - CK - CL - CM - CO - CR - CU - CV - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - NO - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - ST - SV - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW WarningThe values for this field are not able to be modified. |
No |
| Type Text Description The Resource’s email address. Must be between 0 and 80 characters |
No | |
| EmploymentType | Type Picklist Description The nature of employment, such as Full-time, Part-time, and Casual. Valid values are: - Full-time - Part-time - Casual - Agency Custom valuesThe values for this field may be modified via the Skedulo web app or via the Skedulo REST API. |
No |
| GeoLatitude | Type Decimal Description The latitudinal component of the geolocation that corresponds with the Resource’s ‘home address’. Must be a decimal with precision 9 and scale 6 |
No |
| GeoLongitude | Type Decimal Description The longitudinal component of the geolocation that corresponds with the Resource’s ‘home address’. Must be a decimal with precision 9 and scale 6 |
No |
| HomeAddress | Type Text Description The Resource’s base address. Must be between 0 and 255 characters |
No |
| IsActive | Type Checkbox Description Indicates whether or not a Resource is active and can be assigned to work given sufficient availability and appropriate tags, if required. |
Yes |
| MobilePhone | Type Text Description The mobile phone number of the Resource. SMS notifications are sent to this number if the Resource’s ‘Notification Type’ is set to ‘SMS’. Must be between 0 and 40 characters |
No |
| Name | Type Text Description The Resource’s full name. Must be between 0 and 80 characters |
Yes |
| NotificationType | Type Picklist Description The Resource’s default notification method. Valid values are: - sms - push Custom valuesThe values for this field may be modified via the Skedulo REST API. |
No |
| PrimaryPhone | Type Text Description The Resource’s primary phone number. Must be between 0 and 40 characters |
No |
| PrimaryRegion | Type Lookup (Regions) Description The Resource’s primary Region. |
Yes |
| PrimaryRegionId | Type ID Description The Resource’s primary Region. |
Yes |
| Rating | Type Integer Description The Resource’s level of proficiency or ranking. |
No |
| ResourceType | Type Picklist Description The type of Resource. Valid values are: - Person - Asset Custom valuesThe values for this field may be modified via the Skedulo REST API. |
No |
| User | Type Lookup (Users) Description The Resource’s associated User record. |
No |
| UserId | Type ID Description The Resource’s associated User record. |
No |
| WeeklyHours | Type Decimal Description The maximum number of hours a Resource can be scheduled to work in a week.Used by optimization for building constraints if the ‘WorkingHoursMax’, ‘WorkingHoursMin’, ‘WorkingHoursStart’, and ‘WorkingHoursTimePeriod’ fields are not set. Must be a decimal with precision 5 and scale 2 |
No |
| WorkingHoursMax | Type Decimal Description The Resource’s maximum working hours within the ‘working hours time period’ defined. Must be a decimal with precision 5 and scale 2 |
No |
| WorkingHoursMin | Type Decimal Description The Resource’s minimum working hours within the ‘working hours time period’ defined. Must be a decimal with precision 5 and scale 2 |
No |
| WorkingHoursStart | Type Date Description The timestamp when the working hours take effect from. |
No |
| WorkingHoursTimePeriod | Type Picklist Description The period of time for which the ‘working hours min’ and ‘working hours max’ apply. Valid values are: - Week - TwoWeeks - FourWeeks WarningThe values for this field are not able to be modified. |
No |
Related objects
This object has the following related objects.
| Name | Details |
|---|---|
| AccountScores | Object Has many (AccountResourceScores) Description The Account Resources Scores associated with the Resource. |
| Activities | Object Has many (Activities) Description The Activities associated with the Resource. |
| Availabilities | Object Has many (Availabilities) Description The Availabilities associated with the Resource. |
| AvailabilityPatterns | Object Has many (AvailabilityPatternResources) Description The Availability Patterns associated with the Resource. |
| JobAllocations | Object Has many (JobAllocations) Description The Job Allocations associated with the Resource. |
| LocationScores | Object Has many (LocationResourceScores) Description The Location Resources Scores associated with the Resource. |
| ResourceActivities | Object Has many (ActivityResources) Description The Resource Activities associated with the Resource. |
| ResourceOverrides | Object Has many (ResourceOverrides) Description The Resource Overrides associated with the Resource. |
| ResourceRegions | Object Has many (ResourceRegions) Description The secondary Regions associated with the Resource. |
| ResourceShifts | Object Has many (ResourceShifts) Description The Shifts associated with the Resource. |
| ResourceTags | Object Has many (ResourceTags) Description The Tags associated with the Resource. |
Deprecated fields
This section lists fields that are marked as deprecated and are maintained for backwards compatibility purposes only. It’s recommended not to use them in new implementations, as they may be removed in future releases.
- Alias
- AutoSchedule
- Notes
- WorkingHourType
Feedback
Was this page helpful?