機械翻訳について

移動先

• リクエスト
• レスポンス

スケジュール済公開ジョブの作成

post

/content/management/api/v1.1/publish/scheduledJobs

指定されたペイロードでスケジュール済公開ジョブを作成します。

リクエスト

サポートされているメディア・タイプ

• application/json

問合せパラメータ

• validateOnly(optional): boolean
  ジョブを実際に作成/更新せずに入力を検証するコールのみかどうかを示します

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロードに指定された情報でスケジュール済公開ジョブを作成します。リクエスト本文に指定されている場合、フィールドcreatedBy、createdAt、updatedBy、updateAt、validationResults、isCurrentUserManagerは無視されます。 status(取消を除く)を変更しようとすると禁止されます。

ルート・スキーマ : ScheduledJob

型: object

ScheduledJob

ソースを表示

• channels(optional): array channels
  ジョブのチャネル。
• createdAt(optional): string(date-time)
  ジョブの作成時間。
• createdBy(optional): object ScheduledJobUser
  スケジュール済ジョブ・ユーザー・オブジェクト
• currentUserHasChannelsAccess(optional): boolean
  現在のユーザーがスケジュール済公開ジョブのすべてのチャネルにアクセスできるかどうか。
• dependencies(optional): array dependencies
  ジョブの依存関係アイテム。
• description(optional): string
  ジョブの説明。 これは、レスポンスの取得および後処理リクエストのオプションのプロパティです。
• id(optional): string
  ジョブのID。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isCurrentUserManager(optional): boolean
  現在のジョブのユーザー・マネージャである場合、フラグが設定されます。
• items: array items
  ジョブのアイテム。
• missingItems(optional): array missingItems
  スケジュールされた公開のアイテムが見つかりません。
• name: string
  ジョブの名前 これはレスポンス取得の必須プロパティです。
• nextRunTime: string(date-time)
  ジョブの次の実行の時間。
• parentJobId(optional): string
  ジョブ親のID。 現在のジョブが定期公開ジョブのイベント/発生である場合、これはnullではありません。
• publishingStatus(optional): array publishingStatus
  ジョブのステータス・リンクを公開しています。
• recurrence(optional): integer(int32)
  繰返しジョブの繰返し数。
• repositoryId: string
  ジョブが属するリポジトリのID。 これは必須プロパティです。
• schedule(optional): object schedule
  許可される追加のプロパティ: additionalProperties

  スケジュールの時間。
• schedulingResult(optional): object SchedulingResult
  公開ジョブをスケジュールできるかどうか、およびスケジュールをブロックするアイテム
• status(optional): string
  スケジュール済ジョブのステータス。
• targetedChannelPublish(optional): boolean
  公開をターゲット・チャネル公開にするか、選択したチャネル公開するかを指定します。
• type(optional): string
  タイプの名前。
• updatedAt(optional): string(date-time)
  ジョブの最終更新時間。
• updatedBy(optional): object ScheduledJobUser
  スケジュール済ジョブ・ユーザー・オブジェクト
• validationResults(optional): object ItemSubResourceListPublishValidationResult
  アイテムSubResource。
• versions: object versions
  許可される追加のプロパティ: additionalProperties

  ジョブのすべてのアイテムおよび依存関係のバージョン。

{
    "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"
}

ネストされたスキーマ : channels

型: array

ジョブのチャネル。

ソースを表示

• Array of: string

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

ネストされたスキーマ : ScheduledJobUser

型: object

スケジュール済ジョブ・ユーザー・オブジェクト

ソースを表示

• displayName(optional): string
  読取り専用: true

  ユーザーの表示名
• email(optional): string
  読取り専用: true

  ユーザーの電子メール。
• username(optional): string
  読取り専用: true

  ユーザーの名前

{
    "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"
}

ネストされたスキーマ: dependencies

型: array

ジョブの依存関係アイテム。

ソースを表示

• Array of: string

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

ネストされたスキーマ: items

型: array

ジョブのアイテム。

ソースを表示

• Array of: string

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

ネストされたスキーマ : missingItems

型: array

スケジュールされた公開のアイテムが見つかりません。

ソースを表示

• Array of: string

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

ネストされたスキーマ : publishingStatus

型: array

ジョブのステータス・リンクを公開しています。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : schedule

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

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

スケジュールの時間。

ネストされたスキーマ : SchedulingResult

型: object

公開ジョブをスケジュールできるかどうか、およびスケジュールをブロックするアイテム

ソースを表示

• 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"
}

ネストされたスキーマ : ItemSubResourceListPublishValidationResult

型: object

アイテムSubResource。

ソースを表示

• 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."
}

ネストされたスキーマ : versions

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ジョブのすべてのアイテムおよび依存関係のバージョン。

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "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."
}

ネストされたスキーマ: additionalProperties

型: object

ネストされたスキーマ : itemsScheduledByOtherJobs

型: array

ソースを表示

• Array of: string

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object PublishValidationResult
  アイテムをチャネルに公開するための検証結果を公開

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : PublishValidationResult

型: object

アイテムをチャネルに公開するための検証結果を公開

ソースを表示

• 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"
}

ネストされたスキーマ : PolicyValidationResult

型: object

PolicyValidationResult

ソースを表示

• 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"
}

ネストされたスキーマ : TableStringStringString

型: object

ソースを表示

• empty(optional): boolean

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

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelReference

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemSummary

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

ネストされたスキーマ : リクエスト

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ : variationSets

型: array

ソースを表示

• Array of: object ItemVariationSetSummary

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

ネストされたスキーマ : ChannelReference

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ : publishableItems

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : PolicyReference

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ : variationPolicies

型: array

ソースを表示

• Array of: object PolicyReference

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

ネストされたスキーマ : PublishItemId

型: object

ソースを表示

• id(optional): string

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

ネストされたスキーマ : ItemSummary

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

{
    "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"
        }
    }
}

ネストされたスキーマ: dependencies

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : 検証

型: array

ソースを表示

• Array of: object ChannelValidation

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

ネストされたスキーマ : ChannelValidation

型: object

ソースを表示

• 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"
            }
        }
    }
}

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object PolicyRuleResult
  PolicyRuleResult

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

ネストされたスキーマ : PolicyRuleResult

型: object

PolicyRuleResult

ソースを表示

• 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"
}

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ: ids

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : PublishValidation

型: object

PublishValidation

ソースを表示

• languageOnly(optional): boolean
• testOnly(optional): boolean
• verbosity(optional): string
  許容値: [ "none", "terse", "normal", "verbose" ]

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

ネストされたスキーマ : ChannelId

型: object

ChannelId

ソースを表示

• id(optional): string
• isPrimaryChannel(optional): boolean
  チャネルがアセットのプライマリかどうかを示します。
• links(optional): array 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"
}

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ItemVariationSetSummary

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : 検証

型: array

ソースを表示

• Array of: object ChannelValidation

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

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK。

201レスポンス

作成されました。

本文()

ルート・スキーマ : ScheduledJob

型: object

ScheduledJob

ソースを表示

• channels(optional): array channels
  ジョブのチャネル。
• createdAt(optional): string(date-time)
  ジョブの作成時間。
• createdBy(optional): object ScheduledJobUser
  スケジュール済ジョブ・ユーザー・オブジェクト
• currentUserHasChannelsAccess(optional): boolean
  現在のユーザーがスケジュール済公開ジョブのすべてのチャネルにアクセスできるかどうか。
• dependencies(optional): array dependencies
  ジョブの依存関係アイテム。
• description(optional): string
  ジョブの説明。 これは、レスポンスの取得および後処理リクエストのオプションのプロパティです。
• id(optional): string
  ジョブのID。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isCurrentUserManager(optional): boolean
  現在のジョブのユーザー・マネージャである場合、フラグが設定されます。
• items: array items
  ジョブのアイテム。
• missingItems(optional): array missingItems
  スケジュールされた公開のアイテムが見つかりません。
• name: string
  ジョブの名前 これはレスポンス取得の必須プロパティです。
• nextRunTime: string(date-time)
  ジョブの次の実行の時間。
• parentJobId(optional): string
  ジョブ親のID。 現在のジョブが定期公開ジョブのイベント/発生である場合、これはnullではありません。
• publishingStatus(optional): array publishingStatus
  ジョブのステータス・リンクを公開しています。
• recurrence(optional): integer(int32)
  繰返しジョブの繰返し数。
• repositoryId: string
  ジョブが属するリポジトリのID。 これは必須プロパティです。
• schedule(optional): object schedule
  許可される追加のプロパティ: additionalProperties

  スケジュールの時間。
• schedulingResult(optional): object SchedulingResult
  公開ジョブをスケジュールできるかどうか、およびスケジュールをブロックするアイテム
• status(optional): string
  スケジュール済ジョブのステータス。
• targetedChannelPublish(optional): boolean
  公開をターゲット・チャネル公開にするか、選択したチャネル公開するかを指定します。
• type(optional): string
  タイプの名前。
• updatedAt(optional): string(date-time)
  ジョブの最終更新時間。
• updatedBy(optional): object ScheduledJobUser
  スケジュール済ジョブ・ユーザー・オブジェクト
• validationResults(optional): object ItemSubResourceListPublishValidationResult
  アイテムSubResource。
• versions: object versions
  許可される追加のプロパティ: additionalProperties

  ジョブのすべてのアイテムおよび依存関係のバージョン。

{
    "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"
}

ネストされたスキーマ : channels

型: array

ジョブのチャネル。

ソースを表示

• Array of: string

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

ネストされたスキーマ : ScheduledJobUser

型: object

スケジュール済ジョブ・ユーザー・オブジェクト

ソースを表示

• displayName(optional): string
  読取り専用: true

  ユーザーの表示名
• email(optional): string
  読取り専用: true

  ユーザーの電子メール。
• username(optional): string
  読取り専用: true

  ユーザーの名前

{
    "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"
}

ネストされたスキーマ: dependencies

型: array

ジョブの依存関係アイテム。

ソースを表示

• Array of: string

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

ネストされたスキーマ: items

型: array

ジョブのアイテム。

ソースを表示

• Array of: string

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

ネストされたスキーマ : missingItems

型: array

スケジュールされた公開のアイテムが見つかりません。

ソースを表示

• Array of: string

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

ネストされたスキーマ : publishingStatus

型: array

ジョブのステータス・リンクを公開しています。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : schedule

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

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

スケジュールの時間。

ネストされたスキーマ : SchedulingResult

型: object

公開ジョブをスケジュールできるかどうか、およびスケジュールをブロックするアイテム

ソースを表示

• 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"
}

ネストされたスキーマ : ItemSubResourceListPublishValidationResult

型: object

アイテムSubResource。

ソースを表示

• 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."
}

ネストされたスキーマ : versions

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ジョブのすべてのアイテムおよび依存関係のバージョン。

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "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."
}

ネストされたスキーマ: additionalProperties

型: object

ネストされたスキーマ : itemsScheduledByOtherJobs

型: array

ソースを表示

• Array of: string

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object PublishValidationResult
  アイテムをチャネルに公開するための検証結果を公開

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : PublishValidationResult

型: object

アイテムをチャネルに公開するための検証結果を公開

ソースを表示

• 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"
}

ネストされたスキーマ : PolicyValidationResult

型: object

PolicyValidationResult

ソースを表示

• 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"
}

ネストされたスキーマ : TableStringStringString

型: object

ソースを表示

• empty(optional): boolean

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

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelReference

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemSummary

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

ネストされたスキーマ : リクエスト

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ : variationSets

型: array

ソースを表示

• Array of: object ItemVariationSetSummary

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

ネストされたスキーマ : ChannelReference

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ : publishableItems

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : PolicyReference

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ : variationPolicies

型: array

ソースを表示

• Array of: object PolicyReference

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

ネストされたスキーマ : PublishItemId

型: object

ソースを表示

• id(optional): string

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

ネストされたスキーマ : ItemSummary

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

{
    "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"
        }
    }
}

ネストされたスキーマ: dependencies

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : 検証

型: array

ソースを表示

• Array of: object ChannelValidation

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

ネストされたスキーマ : ChannelValidation

型: object

ソースを表示

• 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"
            }
        }
    }
}

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object PolicyRuleResult
  PolicyRuleResult

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

ネストされたスキーマ : PolicyRuleResult

型: object

PolicyRuleResult

ソースを表示

• 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"
}

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ: ids

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : PublishValidation

型: object

PublishValidation

ソースを表示

• languageOnly(optional): boolean
• testOnly(optional): boolean
• verbosity(optional): string
  許容値: [ "none", "terse", "normal", "verbose" ]

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

ネストされたスキーマ : ChannelId

型: object

ChannelId

ソースを表示

• id(optional): string
• isPrimaryChannel(optional): boolean
  チャネルがアセットのプライマリかどうかを示します。
• links(optional): array 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"
}

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ItemVariationSetSummary

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : 検証

型: array

ソースを表示

• Array of: object ChannelValidation

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

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る