Skedulo Availability API is one of 67 APIs that Skedulo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Availability. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
8 operations
across 6 paths,
and defines 58 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: https://api.skedulo.com/auth, https://api.uk.skedulo.com/auth, https://api.ca.skedulo.com/auth, https://api.au.skedulo.com/auth.
The identity and technical contract details declared by the specification.
PatternUpdateTooManyResults
object
When updating a pattern, if more than one result is returned from salesforce or postgres, this error is returned.
1 property
ResultOkAvailabilityPatternResult
object
The UID of the successfully updated pattern.
1 property
AvailabilityPatternRequest
object
The shape of the payload to successfully upsert a pattern.
2 properties
AvailabilityEntryChunk
object
3 properties
3 required
AvailabilityFilterValues
array
Array of availability preference groups used to filter availability based on resource preferences. Each group targets a single objectType (for example, Jobs) a…
PatternInsertError
object
When an insert has failed with DB/Salesforce errors.
1 property
AvailabilityEntryTemplate
object
3 properties
1 required
AvailabilityPatternDetailWeekly
object
Weekly patterns describe patterns that span a single calendar week (always from Monday to Sunday). Optionally, there can be any number of empty padding weeks (…
2 properties
2 required
AvailabilityResult
object
availability is only returned when the availability query parameter is set to true while unavailability is only returned when the unavailability query paramete…
6 properties
2 required
AvailabilityResultSimple
object
Describes the availability information of a single resource. mergedAvailabilities is only returned when the mergedAvailabilities query parameter is set to true.
3 properties
3 required
TimeInterval
object
2 properties
2 required
ResultCreatedAvailabilityPatternResult
object
The UID of the new pattern created.
1 property
AvailabilityEntryChunkHoliday
object
1 property
1 required
AvailabilityEntries
object
2 properties
2 required
SimplePatternAvailabilityEntry
object
Availability entry describing an availability pattern entry.
4 properties
5 required
SimpleHolidayAvailabilityEntry
object
Availability entry describing a holiday entry.
3 properties
3 required
Error
object
2 properties
2 required
AvailabilityEntryPattern
object
3 properties
3 required
AvailabilityEntryRecordCustom
AvailabilityParams
object
7 properties
3 required
AvailabilityFilterEntityIds
object
Map of object type to entity IDs used to resolve availability filter values. Instead of providing availabilityFilterValues directly, supply entity references b…
AvailabilityEntry
object
2 properties
1 required
PatternResourceInsertError
object
When an insert has failed with DB/Salesforce errors.
1 property
AvailabilityEntryRecordTemplate
object
2 properties
2 required
AvailableRegionEntry
object
3 properties
3 required
AvailabilityEntryChunkTemplate
object
3 properties
3 required
AvailabilityPatternDetailCustom
object
Custom patterns describe patterns that span N-number of days. Not all days have to be specified (there can be holes in the pattern). The pattern repeats after…
2 properties
2 required
SimpleAvailabilityParams
object
7 properties
3 required
PatternRequestError
object
If a pattern fails to upsert we will receive this error.
4 properties
4 required
PatternErrors
object
The list of DB/Salesforce errors.
2 properties
2 required
UnavailabilityEntries
object
4 properties
4 required
AvailabilityEntryCustom
object
6 properties
4 required
PatternResourceNotFound
object
When attempting to save and the pattern-resource relationship couldn't be found.
1 property
AvailabilityResults
object
Key of resource ID to AvailabilityResult.
AvailabilityResultsSimple
array
Array of AvailabilityResultSimple objects, each object corresponds to the availability information of a single resource.
AvailabilityDayWithIndex
number
The N-th number of day in the pattern. The index is 1-based (the first day of the pattern is day 1).
Shift
object
6 properties
3 required
AvailabilityCriteria
object
Criteria by which available resources should be determined. Must specify at least one of resourceIds or regionIds.
9 properties
2 required
PatternUpdateInvalid
object
Returned when we encounter a DB/Salesforce update error.
1 property
AvailabilityPatternIntervals
array
A list of time intervals that determine when a resource is available on the day. At least one time interval must be specified for a day; if more intervals are…
AvailabilityWeekday
string
The days of the week
AvailabilityEntryRecordHoliday
AvailabilityEntryHoliday
object
4 properties
4 required
AvailabilityEntryRecordPattern
object
5 properties
5 required
PatternNotFound
object
When a pattern is being updated but does not exist, this error is returned.
1 property
AvailabilityEntryChunkPattern
object
5 properties
5 required
ResultOKAvailability
object
1 property
SimpleOverrideAvailabilityEntry
object
Availability entry describing an availability override.
4 properties
4 required
AvailabilityPatternResource
object
A resource has times they will be made available. This contains the period that a resource will have the pattern applied.
4 properties
2 required
SimpleAvailabilityEntryBase
object
Availability entry object that deterimnes the resources's availability.
4 properties
4 required
PatternResourceUpdateFailed
object
Returned when updating a pattern resource details fails.
1 property
ParseErrorAvailabilityPatternResult
array
A pattern's error will contain the error type, brief message and further details.
AvailabilityEntryChunkCustom
object
1 property
1 required
AvailabilityPatternDetailBase
object
The shape of the availability patterns that determine a resource's availability.
1 property
1 required
ResultOKAvailabilitySimple
object
1 property
SimpleTemplateAvailabilityEntry
object
Availability entry describing an availability template entry.
3 properties
3 required
AvailabilityPattern
object
The pattern of availabilities to determine availability.
4 properties
AvailabilityEntryRecord
object
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Skedulo publishes across the network.
