Job Scheduler - Update Item Schedule

Service:: Core

API Version:: v1

Update an existing schedule for an item.

Required Delegated Scopes:

Item.Execute.All and Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules/{scheduleId}

URI Parameters

Name	In	Required	Type	Description
itemId	path	True	string (uuid)	The item ID.
jobType	path	True	string	The job type.
scheduleId	path	True	string (uuid)	The item schedule ID.
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Required	Type	Description
configuration	True	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig MonthlyScheduleConfig	The actual data contains the time/weekdays of this schedule.
enabled	True	boolean	Whether this schedule is enabled. True - Enabled, False - Disabled.

Responses

Name Type Description

200 OK

Name	Type	Description
200 OK	ItemSchedule	Successfully update the schedule.
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: InsufficientPrivileges - The caller does not have sufficient permissions to access the item ItemNotFound - Requested item id not found

ItemSchedule

Successfully update the schedule.

429 Too Many Requests

ErrorResponse

The service rate limit was exceeded. The server returns a Retry-After header indicating, in seconds, how long the client must wait before sending additional requests.

Headers

Retry-After: integer

Other Status Codes

ErrorResponse

Common error codes:

InsufficientPrivileges - The caller does not have sufficient permissions to access the item
ItemNotFound - Requested item id not found

Examples

update item schedule plan example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/DefaultJob/schedules/3546052c-ae64-4526-b1a8-52af7761426f

{
  "enabled": true,
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  }
}

Sample response

Status code:: 200

{
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "enabled": true,
  "createdDateTime": "2024-04-28T05:35:20.5366667",
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  },
  "owner": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  }
}

Definitions

Name	Description
CronScheduleConfig
DailyScheduleConfig
DayOfMonth	Specifies a date to trigger the job. The value must be a valid date. Otherwise, it will be skipped.
DayOfWeek	Days of the week
EntireTenantPrincipal	Represents a tenant principal
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GroupDetails	Group specific details. Applicable when the principal type is `Group`.
GroupPrincipal	Represents a security group.
GroupType	The type of the group. Additional group types may be added over time.
ItemSchedule	Item schedule.
MonthlyScheduleConfig
OrdinalWeekday	Specifies the ordinal week and weekday to trigger the job. The value must be a valid date. Otherwise, it will be skipped.
PrincipalType	The type of the principal. Additional principal types may be added over time.
ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is `ServicePrincipal`.
ServicePrincipalPrincipal	Represents a Microsoft Entra service principal.
ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Represents a service principal profile.
UpdateScheduleRequest	Update item schedule plan request payload.
UserDetails	User principal specific details. Applicable when the principal type is `User`.
UserPrincipal	Represents a Microsoft Entra user principal.
WeekIndex	The week of the month.
WeeklyScheduleConfig

CronScheduleConfig

Object

Name	Type	Description
endDateTime	string (date-time)	The end time for this schedule. The end time must be later than the start time. It has to be in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
interval	integer (int32) minimum: 1 maximum: 5270400	The time interval in minutes. A number between 1 and 5270400 (10 years).
localTimeZoneId	string	The time zone identifier registry on local computer for windows, see Default Time Zones
startDateTime	string (date-time)	The start time for this schedule. If the start time is in the past, it will trigger a job instantly. The time is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
type	string: Cron	The type of schedule configuration. Additional types may be added over time.

DailyScheduleConfig

Object

Name	Type	Description
endDateTime	string (date-time)	The end time for this schedule. The end time must be later than the start time. It has to be in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
localTimeZoneId	string	The time zone identifier registry on local computer for windows, see Default Time Zones
startDateTime	string (date-time)	The start time for this schedule. If the start time is in the past, it will trigger a job instantly. The time is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
times	string[]	A list of time slots in the hh:mm format. The maximum time slots you can use is 100.
type	string: Daily	The type of schedule configuration. Additional types may be added over time.

DayOfMonth

Object

Specifies a date to trigger the job. The value must be a valid date. Otherwise, it will be skipped.

Name	Type	Description
dayOfMonth	integer (int32) minimum: 1 maximum: 31	Specifies a date to trigger the job, using a value between 1 and 31. For example, 2 means the second day of the month. The date must be valid. If an invalid date is provided, such as February 31st, it will automatically skip to the month that includes the 31st day.
occurrenceType	string: DayOfMonth	An enumerator that lists the day for triggering jobs. Additional types may be added over time.

DayOfWeek

Enumeration

Days of the week

Value	Description
Monday	Monday
Tuesday	Tuesday
Wednesday	Wednesday
Thursday	Thursday
Friday	Friday
Saturday	Saturday
Sunday	Sunday

EntireTenantPrincipal

Object

Represents a tenant principal

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
type	string: EntireTenant	The type of the principal. Additional principal types may be added over time.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string (uuid)	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

GroupDetails

Object

Group specific details. Applicable when the principal type is Group.

Name	Type	Description
groupType	GroupType	The type of the group. Additional group types may be added over time.

GroupPrincipal

Object

Represents a security group.

Name	Type	Description
displayName	string	The principal's display name.
groupDetails	GroupDetails	Group specific details. Applicable when the principal type is `Group`.
id	string (uuid)	The principal's ID.
type	string: Group	The type of the principal. Additional principal types may be added over time.

GroupType

Enumeration

The type of the group. Additional group types may be added over time.

Value	Description
Unknown	Principal group type is unknown.
SecurityGroup	Principal is a security group.
DistributionList	Principal is a distribution list.

ItemSchedule

Object

Item schedule.

Name	Type	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig MonthlyScheduleConfig WeeklyScheduleConfig	The actual data contains the time/weekdays of this schedule.
createdDateTime	string (date-time)	The created time stamp of this schedule in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
enabled	boolean	Whether this schedule is enabled. True - Enabled, False - Disabled.
id	string (uuid)	The schedule ID.
owner	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	The user identity that created this schedule or last modified.

MonthlyScheduleConfig

Object

Name	Type	Description
endDateTime	string (date-time)	The end time for this schedule. The end time must be later than the start time. It has to be in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
localTimeZoneId	string	The time zone identifier registry on local computer for windows, see Default Time Zones
occurrence	MonthlyOccurrence: DayOfMonth OrdinalWeekday	A date for triggering the job.
recurrence	integer (int32) minimum: 1 maximum: 12	Specifies the monthly job repeat interval. For example, when set to 1 the job is triggered every month.
startDateTime	string (date-time)	The start time for this schedule. If the start time is in the past, it will trigger a job instantly. The time is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
times	string[]	A list of time slots in the hh:mm format. The maximum time slots you can use is 100.
type	string: Monthly	The type of schedule configuration. Additional types may be added over time.

OrdinalWeekday

Object

Specifies the ordinal week and weekday to trigger the job. The value must be a valid date. Otherwise, it will be skipped.

Name	Type	Description
occurrenceType	string: OrdinalWeekday	An enumerator that lists the day for triggering jobs. Additional types may be added over time.
weekIndex	WeekIndex	The week of the month.
weekday	DayOfWeek	Week day for triggering jobs.

PrincipalType

Enumeration

The type of the principal. Additional principal types may be added over time.

Value	Description
User	Principal is a Microsoft Entra user principal.
ServicePrincipal	Principal is a Microsoft Entra service principal.
Group	Principal is a security group.
ServicePrincipalProfile	Principal is a service principal profile.
EntireTenant	Principal represents all tenant users.

ServicePrincipalDetails

Object

Service principal specific details. Applicable when the principal type is ServicePrincipal.

Name	Type	Description
aadAppId	string (uuid)	The service principal's Microsoft Entra AppId.

ServicePrincipalPrincipal

Object

Represents a Microsoft Entra service principal.

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
servicePrincipalDetails	ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is `ServicePrincipal`.
type	string: ServicePrincipal	The type of the principal. Additional principal types may be added over time.

ServicePrincipalProfileDetails

Object

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	The service principal profile's parent principal.

ServicePrincipalProfilePrincipal

Object

Represents a service principal profile.

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	The type of the principal. Additional principal types may be added over time.

UpdateScheduleRequest

Object

Update item schedule plan request payload.

Name	Type	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig MonthlyScheduleConfig WeeklyScheduleConfig	The actual data contains the time/weekdays of this schedule.
enabled	boolean	Whether this schedule is enabled. True - Enabled, False - Disabled.

UserDetails

Object

User principal specific details. Applicable when the principal type is User.

Name	Type	Description
userPrincipalName	string	The user principal name.

UserPrincipal

Object

Represents a Microsoft Entra user principal.

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
type	string: User	The type of the principal. Additional principal types may be added over time.
userDetails	UserDetails	User principal specific details. Applicable when the principal type is `User`.

WeekIndex

Enumeration

The week of the month.

Value	Description
First	First.
Second	Second.
Third	Third.
Fourth	Fourth.
Fifth	Fifth.

WeeklyScheduleConfig

Object

Name	Type	Description
endDateTime	string (date-time)	The end time for this schedule. The end time must be later than the start time. It has to be in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
localTimeZoneId	string	The time zone identifier registry on local computer for windows, see Default Time Zones
startDateTime	string (date-time)	The start time for this schedule. If the start time is in the past, it will trigger a job instantly. The time is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
times	string[]	A list of time slots in the hh:mm format. The maximum time slots you can use is 100.
type	string: Weekly	The type of schedule configuration. Additional types may be added over time.
weekdays	DayOfWeek[]	A list of weekdays, at most seven elements are allowed.

Share via

Job Scheduler - Update Item Schedule

Required Delegated Scopes:

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

update item schedule plan example

Sample request

Sample response

Definitions

CronScheduleConfig

DailyScheduleConfig

DayOfMonth

DayOfWeek

EntireTenantPrincipal

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemSchedule

MonthlyScheduleConfig

OrdinalWeekday

PrincipalType

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

UpdateScheduleRequest

UserDetails

UserPrincipal

WeekIndex

WeeklyScheduleConfig