Skedulo Schedule API is one of 67 APIs that Skedulo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Schedule. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
15 operations
across 14 paths,
and defines 130 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.
RequiredCustomAttributes
object
The resource is missing one or more custom attributes that are required by this job
3 properties
3 required
ResourceAvailabilityShape1
object
7 properties
2 required
FrozenJobReason
The specific reason why this job was excluded from the optimization scope
ScopeRegion
object
2 properties
2 required
TimeBounds
object
The time window within which the optimization occurs
2 properties
2 required
PhaseConfigurationShape
object
2 properties
1 required
Error
object
5 properties
4 required
Map_List_ResourceId
object
Activity allocations from the result, keyed by activity ID and mapped to the assigned resource IDs
ScopeJobs
object
8 properties
8 required
FixedTimeBreakShape
object
3 properties
2 required
RollingScheduleWindow
object
2 properties
2 required
ResourceAvailabilityAttributeShape
object
1 property
1 required
AllocationGroupShape
object
5 properties
2 required
LocalDateBounds
object
2 properties
2 required
ResourceRestricted
object
The resource is explicitly restricted for this job via a resource-level include or exclude list and no more specific account or location reason could be identi…
3 properties
3 required
JobDependencyAnchor
string
AllocationDependencyShape
object
5 properties
2 required
ExtraneousResource
object
The resource was not in the optimization request scope but was added to the model because it already had allocations; it cannot be assigned any new work
2 properties
2 required
LocationShape2
object
3 properties
3 required
Saved
object
5 properties
4 required
ResourceCustomConstraintPeriod
object
The resource has a custom period constraint (e.g. a group allocation limit) that is exhausted in the given period, preventing assignment of this job
4 properties
4 required
GraphQLJobTag
object
3 properties
2 required
SharedGroupConstraintShape
object
5 properties
5 required
Paging
object
3 properties
1 required
APIProductRunDetailsShape
object
16 properties
10 required
GraphQLResourceOverride
object
4 properties
2 required
PeriodConstraintsShape1
object
5 properties
2 required
PVRPFeatureOptionsShape
object
17 properties
RunSummary
object
4 properties
4 required
GraphQLJobDependencyTo
object
1 property
1 required
Pending
object
3 properties
2 required
Job
object
9 properties
5 required
SaveMeta
object
2 properties
1 required
TimeConstraintNoOverlap
object
The job's schedule time constraints do not overlap with any resource's availability windows
1 property
1 required
ResourceAvailability
object
2 properties
2 required
CorePVRPFeatureModelShape
object
14 properties
12 required
ScheduleResult
object
1 property
1 required
APIIdInput
object
The ids of entities requested in the optimization run
4 properties
2 required
HasJobDependenciesNotInScope
object
GraphQLJob
object
18 properties
11 required
GraphQLResource
object
13 properties
3 required
ResourceExceedsMaximumHours
object
Assigning this job to the resource would cause it to exceed its maximum working hours within the given period
4 properties
4 required
GroupConstraintsShape
object
2 properties
2 required
Plan
object
6 properties
4 required
ResourceNoFeasibleWindow
object
All of the resource's available time in the scheduling period is blocked by constraints, leaving no feasible window to schedule this job
2 properties
2 required
Day
object
4 properties
4 required
PhaseObjectFilterShape
object
3 properties
3 required
Map_ScheduledResourceRequirement
object
Resource requirements for this job, keyed by resource requirement ID
JobAllocationStatus
string
Map_ResourceId_ResourceAvailability
object
ObjectiveWeightModifiersShape
object
10 properties
AllocationShape1
object
15 properties
7 required
ScheduleRequestShape
object
4 properties
3 required
WindowedBreakShape
object
3 properties
3 required
ResourceNoReasonFound
object
The resource was a candidate for this job but no specific unscheduled reason could be determined
2 properties
2 required
Change
object
3 properties
3 required
Rejected
object
4 properties
3 required
GraphQLLocationResourceScore
object
3 properties
3 required
SchedulePlanShape
object
4 properties
4 required
ResourceLocationRestricted
object
The resource is restricted from being assigned to this job due to a location-level include or exclude list
4 properties
4 required
TransformerDataResponseShape
object
3 properties
3 required
PVRPProductOptionsShape
object
22 properties
JobExcluded
object
The job was excluded from optimization before it began because it was identified as a frozen job not eligible for scheduling
2 properties
2 required
ResourceRequirementJob
object
10 properties
6 required
InsertJobAllocations
object
3 properties
2 required
GraphQLResourceRequirement
object
3 properties
3 required
ResourceNoAvailabilityOverlapWithTimeConstraints
object
The resource's availability windows do not overlap with any of the job's schedule time constraints
2 properties
2 required
RoutesShape
object
13 properties
12 required
ComparisonTotal
object
2 properties
2 required
Availability
object
2 properties
2 required
JobCannotBeFullyAllocated
object
The job requires multiple resource allocations but at least one allocation could not be fulfilled, resulting in partial or no scheduling
2 properties
2 required
TimeConstraintBeforePeriod
object
All of the job's schedule time constraints fall entirely before the scheduling period
1 property
1 required
ResultsShape
object
6 properties
6 required
Map_List_FrozenJobReason
object
Jobs excluded from optimization before it began (frozen jobs), keyed by job ID with the reasons for exclusion
ScopeRequest
object
3 properties
3 required
TimeConstraintAfterPeriod
object
All of the job's schedule time constraints fall entirely after the scheduling period
1 property
1 required
ScheduleRunWindow
object
2 properties
2 required
ScopeResource
object
2 properties
2 required
Resource
object
9 properties
6 required
GraphQLTag
object
1 property
1 required
AllocationResourceConstraintShape
object
Restricts which resources may be assigned to this allocation (blocked or allowed list)
2 properties
2 required
GraphQLResourcePrimaryRegion
object
1 property
1 required
Deprecated
object
1 property
1 required
ScheduledResourceRequirement
object
2 properties
2 required
GraphQLJobDependencyFrom
object
5 properties
1 required
ResourceAccountRestricted
object
The resource is restricted from being assigned to this job due to an account-level include or exclude list
4 properties
4 required
Unknown
object
8 properties
4 required
Activity
object
9 properties
5 required
ObjectiveWeightsShape
object
10 properties
ScheduledJob
object
6 properties
6 required
ResourceAttributeShape
object
1 property
1 required
Map_ResourceId_ScopeResource
object
ResourceDependencyShape
object
1 property
1 required
GraphQLResourceTag
object
2 properties
1 required
GraphQLActivityResource
object
1 property
1 required
StringifiedRunError
object
1 property
1 required
JobLocked
object
The job is locked to its current resource and time and cannot be reassigned by the optimizer
1 property
1 required
GraphQLAccountResourceScore
object
3 properties
3 required
GraphQLJobTimeConstraint
object
4 properties
1 required
UnscheduledJob
object
2 properties
2 required
NotInRequestedJobs
object
GraphQLRegion
object
4 properties
1 required
ScheduleTimeConstraintShape
object
2 properties
2 required
ExhaustedAvailability
object
The resource has no remaining availability in the scheduling period that could accommodate this job
2 properties
2 required
Map_ScheduledJob
object
Jobs that were successfully scheduled, keyed by job ID
AllocationAttributeShape
object
2 properties
1 required
AllocationResourceRatingShape
object
2 properties
2 required
APIProductData
object
All the data retrieved from GraphQL to run the optimization
12 properties
9 required
ResourceShape1
object
11 properties
5 required
RequiredTags
object
The resource is missing one or more tags that are required by this job
3 properties
3 required
CorePVRPRunParamsShape
object
8 properties
6 required
Home
object
7 properties
3 required
Scope
object
5 properties
5 required
GraphQLActivity
object
8 properties
4 required
UpdateJobs
object
3 properties
1 required
SchedulePlanOptionsShape
object
4 properties
1 required
ResultTotals
object
Aggregate counts of scheduled and unscheduled jobs for the run
2 properties
2 required
Map_UnscheduledJob
object
Jobs that could not be scheduled and the reasons why, keyed by job ID
RegionAvailability
object
3 properties
3 required
GraphQLJobAllocation
object
4 properties
3 required
TransformerDataShape
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Skedulo publishes across the network.
