Jump to

• Request
• Response

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 onwards

  Default 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" ]

Body ()

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.

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: additionalProperties

  Time 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: additionalProperties

  Versions of all items and dependencies of the job.

{
    "type":"object",
    "required":[
        "items",
        "name",
        "nextRunTime",
        "repositoryId",
        "versions"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"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."
        },
        "name":{
            "type":"string",
            "description":"Name of the Job. It is a required property in the get response."
        },
        "description":{
            "type":"string",
            "description":"Description of the job. It is an optional property in the get response and post/put request."
        },
        "repositoryId":{
            "type":"string",
            "description":"Id of the repository which the job belongs to. This is a required property."
        },
        "targetedChannelPublish":{
            "type":"boolean",
            "description":"Indicate whether the publish is targeted channel publish or selected channel publish. "
        },
        "createdBy":{
            "description":"Name of the created user. ",
            "$ref":"#/definitions/ScheduledJobUser"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time",
            "description":"Time of the creation of the job. "
        },
        "updatedBy":{
            "description":"Name of the last updated user. ",
            "$ref":"#/definitions/ScheduledJobUser"
        },
        "updatedAt":{
            "type":"string",
            "format":"date-time",
            "description":"Time of the last update of the job. "
        },
        "schedule":{
            "type":"object",
            "description":"Time of the schedule. ",
            "additionalProperties":{
                "type":"object"
            }
        },
        "recurrence":{
            "type":"integer",
            "format":"int32",
            "description":"Number of repeats for the recurring job. "
        },
        "nextRunTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time of the next run of the job."
        },
        "status":{
            "type":"string",
            "description":"Status of the scheduled job. "
        },
        "items":{
            "type":"array",
            "description":"Items of the job. ",
            "items":{
                "type":"string"
            }
        },
        "dependencies":{
            "type":"array",
            "description":"Dependency items of the job. ",
            "items":{
                "type":"string"
            }
        },
        "versions":{
            "type":"object",
            "description":"Versions of all items and dependencies of the job. ",
            "additionalProperties":{
                "type":"string"
            }
        },
        "channels":{
            "type":"array",
            "description":"Channels of the job. ",
            "items":{
                "type":"string"
            }
        },
        "schedulingResult":{
            "description":"Scheduling results of the job. ",
            "$ref":"#/definitions/SchedulingResult"
        },
        "validationResults":{
            "$ref":"#/definitions/ItemSubResourceListPublishValidationResult"
        },
        "parentJobId":{
            "type":"string",
            "description":"id of the job's parent. If the current job is an event/occurrence of a recurring publish job, this will be non-null."
        },
        "type":{
            "type":"string",
            "description":"Name of the type. "
        },
        "missingItems":{
            "type":"array",
            "description":"Items not found for scheduled publish.",
            "items":{
                "type":"string"
            }
        },
        "isCurrentUserManager":{
            "type":"boolean",
            "description":"Flag is set if current is user manager of the job."
        },
        "currentUserHasChannelsAccess":{
            "type":"boolean",
            "description":"Whether the current user has access to all channels of the scheduled publish job."
        },
        "publishingStatus":{
            "type":"array",
            "description":"Publishing status links of the Job.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ScheduledJob"
}

Nested Schema : channels

Type: array

Channels of the job.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Channels of the job. ",
    "items":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "username":{
            "type":"string",
            "description":"name of the user.",
            "readOnly":true
        },
        "displayName":{
            "type":"string",
            "description":"display name of the user.",
            "readOnly":true
        },
        "email":{
            "type":"string",
            "description":"email of the user.",
            "readOnly":true
        }
    },
    "description":"Scheduled Job User object"
}

Nested Schema : dependencies

Type: array

Dependency items of the job.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Dependency items of the job. ",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Items of the job.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Items of the job. ",
    "items":{
        "type":"string"
    }
}

Nested Schema : missingItems

Type: array

Items not found for scheduled publish.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Items not found for scheduled publish.",
    "items":{
        "type":"string"
    }
}

Nested Schema : publishingStatus

Type: array

Publishing status links of the Job.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Publishing status links of the Job.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : schedule

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Time of the schedule. ",
    "additionalProperties":{
        "type":"object"
    }
}

Time of the schedule.

Nested Schema : SchedulingResult

Type: object

Whether the publish job can be scheduled and what items block the schedule

Show Source

• canSchedule(optional): boolean
• itemsScheduledByOtherJobs(optional): array itemsScheduledByOtherJobs

{
    "type":"object",
    "properties":{
        "canSchedule":{
            "type":"boolean"
        },
        "itemsScheduledByOtherJobs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Whether the publish job can be scheduled and what items block the schedule"
}

Nested Schema : ItemSubResourceListPublishValidationResult

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishValidationResult"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : versions

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Versions of all items and dependencies of the job. ",
    "additionalProperties":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : additionalProperties

Type: object

Nested Schema : itemsScheduledByOtherJobs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object PublishValidationResult
  Publish validation result for publishing items to channels

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishValidationResult"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PublishValidationResult

Type: object

Publish validation result for publishing items to channels

Show Source

• error(optional): string
• policyValidation(optional): object PolicyValidationResult
  PolicyValidationResult

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string"
        },
        "policyValidation":{
            "$ref":"#/definitions/PolicyValidationResult"
        }
    },
    "description":"Publish validation result for publishing items to channels"
}

Nested Schema : PolicyValidationResult

Type: object

PolicyValidationResult

Show Source

• ChannelItemDocIds(optional): object TableStringStringString
• channels(optional): array channels
• error(optional): string
• items(optional): array items
• processingTime(optional): integer(int64)
• request(optional): object Request
• valid(optional): boolean
• variationSets(optional): array variationSets

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelReference"
            }
        },
        "variationSets":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemVariationSetSummary"
            }
        },
        "ChannelItemDocIds":{
            "description":"Table",
            "$ref":"#/definitions/TableStringStringString"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemSummary"
            }
        },
        "request":{
            "$ref":"#/definitions/Request"
        },
        "processingTime":{
            "type":"integer",
            "format":"int64"
        },
        "valid":{
            "type":"boolean"
        },
        "error":{
            "type":"string"
        }
    },
    "description":"PolicyValidationResult"
}

Nested Schema : TableStringStringString

Type: object

Show Source

• empty(optional): boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    }
}

Nested Schema : channels

Type: array

Show Source

• Array of: object ChannelReference

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelReference"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ItemSummary

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ItemSummary"
    }
}

Nested Schema : Request

Type: object

Show Source

• channels(optional): array channels
• ids(optional): array ids
• validation(optional): object PublishValidation
  PublishValidation

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "ids":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "validation":{
            "$ref":"#/definitions/PublishValidation"
        }
    }
}

Nested Schema : variationSets

Type: array

Show Source

• Array of: object ItemVariationSetSummary

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ItemVariationSetSummary"
    }
}

Nested Schema : ChannelReference

Type: object

Show Source

• error(optional): string
• id(optional): string
• name(optional): string
• publishableItems(optional): array publishableItems
• publishPolicy(optional): object PolicyReference
• variationPolicies(optional): array variationPolicies

{
    "type":"object",
    "properties":{
        "variationPolicies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyReference"
            }
        },
        "publishPolicy":{
            "$ref":"#/definitions/PolicyReference"
        },
        "publishableItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "error":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : publishableItems

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : PolicyReference

Type: object

Show Source

• error(optional): string
• id(optional): string
• name(optional): string
• varType(optional): string

{
    "type":"object",
    "properties":{
        "varType":{
            "type":"string"
        },
        "error":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : variationPolicies

Type: array

Show Source

• Array of: object PolicyReference

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyReference"
    }
}

Nested Schema : PublishItemId

Type: object

Show Source

• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ItemSummary

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "optionalDependency":{
            "type":"string"
        },
        "dependencies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "fileId":{
            "type":"string"
        },
        "primaryChannelId":{
            "type":"string"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelValidation"
            }
        },
        "dependencyStatus":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "language":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : dependencies

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : validations

Type: array

Show Source

• Array of: object ChannelValidation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelValidation"
    }
}

Nested Schema : ChannelValidation

Type: object

Show Source

• alreadyPublished(optional): boolean
• blocking(optional): boolean
• channelId(optional): string
• policyStatus(optional): string
• publishable(optional): boolean
• results(optional): array results

{
    "type":"object",
    "properties":{
        "publishable":{
            "type":"boolean"
        },
        "channelId":{
            "type":"string"
        },
        "alreadyPublished":{
            "type":"boolean"
        },
        "blocking":{
            "type":"boolean"
        },
        "policyStatus":{
            "type":"string"
        },
        "results":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyRuleResult"
            }
        }
    }
}

Nested Schema : results

Type: array

Show Source

• Array of: object PolicyRuleResult
  PolicyRuleResult

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyRuleResult"
    }
}

Nested Schema : PolicyRuleResult

Type: object

PolicyRuleResult

Show Source

• code(optional): string
• fileId(optional): string
• itemId(optional): string
• message(optional): string
• name(optional): string
• pass(optional): string
• policyId(optional): string
• rule(optional): string
• setId(optional): string
• valid(optional): boolean
• value(optional): string

{
    "type":"object",
    "properties":{
        "policyId":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "rule":{
            "type":"string"
        },
        "pass":{
            "type":"string"
        },
        "itemId":{
            "type":"string"
        },
        "setId":{
            "type":"string"
        },
        "fileId":{
            "type":"string"
        },
        "valid":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    },
    "description":"PolicyRuleResult"
}

Nested Schema : channels

Type: array

Show Source

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

Nested Schema : ids

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : PublishValidation

Type: object

PublishValidation

Show Source

• languageOnly(optional): boolean
• testOnly(optional): boolean
• verbosity(optional): string
  Allowed Values: [ "none", "terse", "normal", "verbose" ]

{
    "type":"object",
    "properties":{
        "verbosity":{
            "type":"string",
            "enum":[
                "none",
                "terse",
                "normal",
                "verbose"
            ]
        },
        "testOnly":{
            "type":"boolean"
        },
        "languageOnly":{
            "type":"boolean"
        }
    },
    "description":"PublishValidation"
}

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ItemVariationSetSummary

Type: object

Show Source

• id(optional): string
• items(optional): array items
• masterItemId(optional): string
• type(optional): string
• validations(optional): array validations
• varType(optional): string

{
    "type":"object",
    "properties":{
        "varType":{
            "type":"string"
        },
        "masterItemId":{
            "type":"string"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelValidation"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : validations

Type: array

Show Source

• Array of: object ChannelValidation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelValidation"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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: additionalProperties

  Time 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: additionalProperties

  Versions of all items and dependencies of the job.

{
    "type":"object",
    "required":[
        "items",
        "name",
        "nextRunTime",
        "repositoryId",
        "versions"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"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."
        },
        "name":{
            "type":"string",
            "description":"Name of the Job. It is a required property in the get response."
        },
        "description":{
            "type":"string",
            "description":"Description of the job. It is an optional property in the get response and post/put request."
        },
        "repositoryId":{
            "type":"string",
            "description":"Id of the repository which the job belongs to. This is a required property."
        },
        "targetedChannelPublish":{
            "type":"boolean",
            "description":"Indicate whether the publish is targeted channel publish or selected channel publish. "
        },
        "createdBy":{
            "description":"Name of the created user. ",
            "$ref":"#/definitions/ScheduledJobUser"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time",
            "description":"Time of the creation of the job. "
        },
        "updatedBy":{
            "description":"Name of the last updated user. ",
            "$ref":"#/definitions/ScheduledJobUser"
        },
        "updatedAt":{
            "type":"string",
            "format":"date-time",
            "description":"Time of the last update of the job. "
        },
        "schedule":{
            "type":"object",
            "description":"Time of the schedule. ",
            "additionalProperties":{
                "type":"object"
            }
        },
        "recurrence":{
            "type":"integer",
            "format":"int32",
            "description":"Number of repeats for the recurring job. "
        },
        "nextRunTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time of the next run of the job."
        },
        "status":{
            "type":"string",
            "description":"Status of the scheduled job. "
        },
        "items":{
            "type":"array",
            "description":"Items of the job. ",
            "items":{
                "type":"string"
            }
        },
        "dependencies":{
            "type":"array",
            "description":"Dependency items of the job. ",
            "items":{
                "type":"string"
            }
        },
        "versions":{
            "type":"object",
            "description":"Versions of all items and dependencies of the job. ",
            "additionalProperties":{
                "type":"string"
            }
        },
        "channels":{
            "type":"array",
            "description":"Channels of the job. ",
            "items":{
                "type":"string"
            }
        },
        "schedulingResult":{
            "description":"Scheduling results of the job. ",
            "$ref":"#/definitions/SchedulingResult"
        },
        "validationResults":{
            "$ref":"#/definitions/ItemSubResourceListPublishValidationResult"
        },
        "parentJobId":{
            "type":"string",
            "description":"id of the job's parent. If the current job is an event/occurrence of a recurring publish job, this will be non-null."
        },
        "type":{
            "type":"string",
            "description":"Name of the type. "
        },
        "missingItems":{
            "type":"array",
            "description":"Items not found for scheduled publish.",
            "items":{
                "type":"string"
            }
        },
        "isCurrentUserManager":{
            "type":"boolean",
            "description":"Flag is set if current is user manager of the job."
        },
        "currentUserHasChannelsAccess":{
            "type":"boolean",
            "description":"Whether the current user has access to all channels of the scheduled publish job."
        },
        "publishingStatus":{
            "type":"array",
            "description":"Publishing status links of the Job.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ScheduledJob"
}

Nested Schema : channels

Type: array

Channels of the job.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Channels of the job. ",
    "items":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "username":{
            "type":"string",
            "description":"name of the user.",
            "readOnly":true
        },
        "displayName":{
            "type":"string",
            "description":"display name of the user.",
            "readOnly":true
        },
        "email":{
            "type":"string",
            "description":"email of the user.",
            "readOnly":true
        }
    },
    "description":"Scheduled Job User object"
}

Nested Schema : dependencies

Type: array

Dependency items of the job.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Dependency items of the job. ",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Items of the job.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Items of the job. ",
    "items":{
        "type":"string"
    }
}

Nested Schema : missingItems

Type: array

Items not found for scheduled publish.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Items not found for scheduled publish.",
    "items":{
        "type":"string"
    }
}

Nested Schema : publishingStatus

Type: array

Publishing status links of the Job.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Publishing status links of the Job.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : schedule

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Time of the schedule. ",
    "additionalProperties":{
        "type":"object"
    }
}

Time of the schedule.

Nested Schema : SchedulingResult

Type: object

Whether the publish job can be scheduled and what items block the schedule

Show Source

• canSchedule(optional): boolean
• itemsScheduledByOtherJobs(optional): array itemsScheduledByOtherJobs

{
    "type":"object",
    "properties":{
        "canSchedule":{
            "type":"boolean"
        },
        "itemsScheduledByOtherJobs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Whether the publish job can be scheduled and what items block the schedule"
}

Nested Schema : ItemSubResourceListPublishValidationResult

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishValidationResult"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : versions

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Versions of all items and dependencies of the job. ",
    "additionalProperties":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : additionalProperties

Type: object

Nested Schema : itemsScheduledByOtherJobs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object PublishValidationResult
  Publish validation result for publishing items to channels

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishValidationResult"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PublishValidationResult

Type: object

Publish validation result for publishing items to channels

Show Source

• error(optional): string
• policyValidation(optional): object PolicyValidationResult
  PolicyValidationResult

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string"
        },
        "policyValidation":{
            "$ref":"#/definitions/PolicyValidationResult"
        }
    },
    "description":"Publish validation result for publishing items to channels"
}

Nested Schema : PolicyValidationResult

Type: object

PolicyValidationResult

Show Source

• ChannelItemDocIds(optional): object TableStringStringString
• channels(optional): array channels
• error(optional): string
• items(optional): array items
• processingTime(optional): integer(int64)
• request(optional): object Request
• valid(optional): boolean
• variationSets(optional): array variationSets

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelReference"
            }
        },
        "variationSets":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemVariationSetSummary"
            }
        },
        "ChannelItemDocIds":{
            "description":"Table",
            "$ref":"#/definitions/TableStringStringString"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemSummary"
            }
        },
        "request":{
            "$ref":"#/definitions/Request"
        },
        "processingTime":{
            "type":"integer",
            "format":"int64"
        },
        "valid":{
            "type":"boolean"
        },
        "error":{
            "type":"string"
        }
    },
    "description":"PolicyValidationResult"
}

Nested Schema : TableStringStringString

Type: object

Show Source

• empty(optional): boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    }
}

Nested Schema : channels

Type: array

Show Source

• Array of: object ChannelReference

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelReference"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ItemSummary

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ItemSummary"
    }
}

Nested Schema : Request

Type: object

Show Source

• channels(optional): array channels
• ids(optional): array ids
• validation(optional): object PublishValidation
  PublishValidation

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "ids":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "validation":{
            "$ref":"#/definitions/PublishValidation"
        }
    }
}

Nested Schema : variationSets

Type: array

Show Source

• Array of: object ItemVariationSetSummary

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ItemVariationSetSummary"
    }
}

Nested Schema : ChannelReference

Type: object

Show Source

• error(optional): string
• id(optional): string
• name(optional): string
• publishableItems(optional): array publishableItems
• publishPolicy(optional): object PolicyReference
• variationPolicies(optional): array variationPolicies

{
    "type":"object",
    "properties":{
        "variationPolicies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyReference"
            }
        },
        "publishPolicy":{
            "$ref":"#/definitions/PolicyReference"
        },
        "publishableItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "error":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : publishableItems

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : PolicyReference

Type: object

Show Source

• error(optional): string
• id(optional): string
• name(optional): string
• varType(optional): string

{
    "type":"object",
    "properties":{
        "varType":{
            "type":"string"
        },
        "error":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : variationPolicies

Type: array

Show Source

• Array of: object PolicyReference

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyReference"
    }
}

Nested Schema : PublishItemId

Type: object

Show Source

• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ItemSummary

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "optionalDependency":{
            "type":"string"
        },
        "dependencies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "fileId":{
            "type":"string"
        },
        "primaryChannelId":{
            "type":"string"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelValidation"
            }
        },
        "dependencyStatus":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "language":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : dependencies

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : validations

Type: array

Show Source

• Array of: object ChannelValidation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelValidation"
    }
}

Nested Schema : ChannelValidation

Type: object

Show Source

• alreadyPublished(optional): boolean
• blocking(optional): boolean
• channelId(optional): string
• policyStatus(optional): string
• publishable(optional): boolean
• results(optional): array results

{
    "type":"object",
    "properties":{
        "publishable":{
            "type":"boolean"
        },
        "channelId":{
            "type":"string"
        },
        "alreadyPublished":{
            "type":"boolean"
        },
        "blocking":{
            "type":"boolean"
        },
        "policyStatus":{
            "type":"string"
        },
        "results":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyRuleResult"
            }
        }
    }
}

Nested Schema : results

Type: array

Show Source

• Array of: object PolicyRuleResult
  PolicyRuleResult

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyRuleResult"
    }
}

Nested Schema : PolicyRuleResult

Type: object

PolicyRuleResult

Show Source

• code(optional): string
• fileId(optional): string
• itemId(optional): string
• message(optional): string
• name(optional): string
• pass(optional): string
• policyId(optional): string
• rule(optional): string
• setId(optional): string
• valid(optional): boolean
• value(optional): string

{
    "type":"object",
    "properties":{
        "policyId":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "rule":{
            "type":"string"
        },
        "pass":{
            "type":"string"
        },
        "itemId":{
            "type":"string"
        },
        "setId":{
            "type":"string"
        },
        "fileId":{
            "type":"string"
        },
        "valid":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    },
    "description":"PolicyRuleResult"
}

Nested Schema : channels

Type: array

Show Source

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

Nested Schema : ids

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : PublishValidation

Type: object

PublishValidation

Show Source

• languageOnly(optional): boolean
• testOnly(optional): boolean
• verbosity(optional): string
  Allowed Values: [ "none", "terse", "normal", "verbose" ]

{
    "type":"object",
    "properties":{
        "verbosity":{
            "type":"string",
            "enum":[
                "none",
                "terse",
                "normal",
                "verbose"
            ]
        },
        "testOnly":{
            "type":"boolean"
        },
        "languageOnly":{
            "type":"boolean"
        }
    },
    "description":"PublishValidation"
}

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ItemVariationSetSummary

Type: object

Show Source

• id(optional): string
• items(optional): array items
• masterItemId(optional): string
• type(optional): string
• validations(optional): array validations
• varType(optional): string

{
    "type":"object",
    "properties":{
        "varType":{
            "type":"string"
        },
        "masterItemId":{
            "type":"string"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelValidation"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object PublishItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishItemId"
    }
}

Nested Schema : validations

Type: array

Show Source

• Array of: object ChannelValidation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelValidation"
    }
}

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top