Update a scheduled publish job
put
/content/management/api/v1.1/publish/scheduledJobs
Updates a scheduled publish child job only, as per the provided parentJobId, nextRunTime, with the given payload. Please note that schedule is standard for recurring events/child jobs as they are differentiated by nextRunTime.
Request
Supported Media Types
- application/json
Query Parameters
-
cancelSeries(optional): boolean
Indicates whether the whole recurrence series is to be cancelled this point onwardsDefault Value:
false
-
q: string
This parameter accepts a query expression condition that matches the field values. The value of query condition follows the format of {fieldName} {operator} "{fieldValue}". Multiple mentions of field status not supported.
-
validateOnly(optional): boolean
Indicates whether the call is only to validate the input without actually creating/updating the job
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Updates the scheduled publish job with given information in the payload.
Note: For recurring jobs, the name can only be modified on the parent job, as they remain common across all recurring job events. description, however can be unique to recurring job instances.
Note: For recurring jobs, the name can only be modified on the parent job, as they remain common across all recurring job events. description, however can be unique to recurring job instances.
Root Schema : ScheduledJob
Type:
object
ScheduledJob
Show Source
-
channels(optional):
array channels
Channels of the job.
-
createdAt(optional):
string(date-time)
Time of the creation of the job.
-
createdBy(optional):
object ScheduledJobUser
Scheduled Job User object
-
currentUserHasChannelsAccess(optional):
boolean
Whether the current user has access to all channels of the scheduled publish job.
-
dependencies(optional):
array dependencies
Dependency items of the job.
-
description(optional):
string
Description of the job. It is an optional property in the get response and post/put request.
-
id(optional):
string
id of the job. It is a required property in the get response and put request whereas it is not required in the post request.
-
isCurrentUserManager(optional):
boolean
Flag is set if current is user manager of the job.
-
items:
array items
Items of the job.
-
missingItems(optional):
array missingItems
Items not found for scheduled publish.
-
name:
string
Name of the Job. It is a required property in the get response.
-
nextRunTime:
string(date-time)
Time of the next run of the job.
-
parentJobId(optional):
string
id of the job's parent. If the current job is an event/occurrence of a recurring publish job, this will be non-null.
-
publishingStatus(optional):
array publishingStatus
Publishing status links of the Job.
-
recurrence(optional):
integer(int32)
Number of repeats for the recurring job.
-
repositoryId:
string
Id of the repository which the job belongs to. This is a required property.
-
schedule(optional):
object schedule
Additional Properties Allowed: additionalPropertiesTime of the schedule.
-
schedulingResult(optional):
object SchedulingResult
Whether the publish job can be scheduled and what items block the schedule
-
status(optional):
string
Status of the scheduled job.
-
targetedChannelPublish(optional):
boolean
Indicate whether the publish is targeted channel publish or selected channel publish.
-
type(optional):
string
Name of the type.
-
updatedAt(optional):
string(date-time)
Time of the last update of the job.
-
updatedBy(optional):
object ScheduledJobUser
Scheduled Job User object
-
validationResults(optional):
object ItemSubResourceListPublishValidationResult
Item SubResource.
-
versions:
object versions
Additional Properties Allowed: additionalPropertiesVersions of all items and dependencies of the job.
Nested Schema : ScheduledJobUser
Type:
object
Scheduled Job User object
Show Source
-
displayName(optional):
string
Read Only:
true
display name of the user. -
email(optional):
string
Read Only:
true
email of the user. -
username(optional):
string
Read Only:
true
name of the user.
Nested Schema : publishingStatus
Type:
array
Publishing status links of the Job.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : schedule
Type:
object
Additional Properties Allowed
Show Source
Time of the schedule.
Nested Schema : SchedulingResult
Type:
object
Whether the publish job can be scheduled and what items block the schedule
Show Source
Nested Schema : ItemSubResourceListPublishValidationResult
Type:
object
Item SubResource.
Show Source
Nested Schema : versions
Type:
object
Additional Properties Allowed
Show Source
Versions of all items and dependencies of the job.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
Nested Schema : additionalProperties
Type:
object
Nested Schema : data
Type:
Show Source
array
-
Array of:
object PublishValidationResult
Publish validation result for publishing items to channels
Nested Schema : PublishValidationResult
Type:
object
Publish validation result for publishing items to channels
Show Source
-
error(optional):
string
-
policyValidation(optional):
object PolicyValidationResult
PolicyValidationResult
Nested Schema : ItemSummary
Type:
Show Source
object
-
dependencies(optional):
array dependencies
-
dependencyStatus(optional):
string
-
fileId(optional):
string
-
id(optional):
string
-
language(optional):
string
-
name(optional):
string
-
optionalDependency(optional):
string
-
primaryChannelId(optional):
string
-
type(optional):
string
-
validations(optional):
array validations
-
version(optional):
string
Nested Schema : PublishValidation
Type:
object
PublishValidation
Show Source
-
languageOnly(optional):
boolean
-
testOnly(optional):
boolean
-
verbosity(optional):
string
Allowed Values:
[ "none", "terse", "normal", "verbose" ]
Nested Schema : ChannelId
Type:
object
ChannelId
Show Source
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ScheduledJob
Type:
object
ScheduledJob
Show Source
-
channels(optional):
array channels
Channels of the job.
-
createdAt(optional):
string(date-time)
Time of the creation of the job.
-
createdBy(optional):
object ScheduledJobUser
Scheduled Job User object
-
currentUserHasChannelsAccess(optional):
boolean
Whether the current user has access to all channels of the scheduled publish job.
-
dependencies(optional):
array dependencies
Dependency items of the job.
-
description(optional):
string
Description of the job. It is an optional property in the get response and post/put request.
-
id(optional):
string
id of the job. It is a required property in the get response and put request whereas it is not required in the post request.
-
isCurrentUserManager(optional):
boolean
Flag is set if current is user manager of the job.
-
items:
array items
Items of the job.
-
missingItems(optional):
array missingItems
Items not found for scheduled publish.
-
name:
string
Name of the Job. It is a required property in the get response.
-
nextRunTime:
string(date-time)
Time of the next run of the job.
-
parentJobId(optional):
string
id of the job's parent. If the current job is an event/occurrence of a recurring publish job, this will be non-null.
-
publishingStatus(optional):
array publishingStatus
Publishing status links of the Job.
-
recurrence(optional):
integer(int32)
Number of repeats for the recurring job.
-
repositoryId:
string
Id of the repository which the job belongs to. This is a required property.
-
schedule(optional):
object schedule
Additional Properties Allowed: additionalPropertiesTime of the schedule.
-
schedulingResult(optional):
object SchedulingResult
Whether the publish job can be scheduled and what items block the schedule
-
status(optional):
string
Status of the scheduled job.
-
targetedChannelPublish(optional):
boolean
Indicate whether the publish is targeted channel publish or selected channel publish.
-
type(optional):
string
Name of the type.
-
updatedAt(optional):
string(date-time)
Time of the last update of the job.
-
updatedBy(optional):
object ScheduledJobUser
Scheduled Job User object
-
validationResults(optional):
object ItemSubResourceListPublishValidationResult
Item SubResource.
-
versions:
object versions
Additional Properties Allowed: additionalPropertiesVersions of all items and dependencies of the job.
Nested Schema : ScheduledJobUser
Type:
object
Scheduled Job User object
Show Source
-
displayName(optional):
string
Read Only:
true
display name of the user. -
email(optional):
string
Read Only:
true
email of the user. -
username(optional):
string
Read Only:
true
name of the user.
Nested Schema : publishingStatus
Type:
array
Publishing status links of the Job.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : schedule
Type:
object
Additional Properties Allowed
Show Source
Time of the schedule.
Nested Schema : SchedulingResult
Type:
object
Whether the publish job can be scheduled and what items block the schedule
Show Source
Nested Schema : ItemSubResourceListPublishValidationResult
Type:
object
Item SubResource.
Show Source
Nested Schema : versions
Type:
object
Additional Properties Allowed
Show Source
Versions of all items and dependencies of the job.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
Nested Schema : additionalProperties
Type:
object
Nested Schema : data
Type:
Show Source
array
-
Array of:
object PublishValidationResult
Publish validation result for publishing items to channels
Nested Schema : PublishValidationResult
Type:
object
Publish validation result for publishing items to channels
Show Source
-
error(optional):
string
-
policyValidation(optional):
object PolicyValidationResult
PolicyValidationResult
Nested Schema : ItemSummary
Type:
Show Source
object
-
dependencies(optional):
array dependencies
-
dependencyStatus(optional):
string
-
fileId(optional):
string
-
id(optional):
string
-
language(optional):
string
-
name(optional):
string
-
optionalDependency(optional):
string
-
primaryChannelId(optional):
string
-
type(optional):
string
-
validations(optional):
array validations
-
version(optional):
string
Nested Schema : PublishValidation
Type:
object
PublishValidation
Show Source
-
languageOnly(optional):
boolean
-
testOnly(optional):
boolean
-
verbosity(optional):
string
Allowed Values:
[ "none", "terse", "normal", "verbose" ]
Nested Schema : ChannelId
Type:
object
ChannelId
Show Source
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.