コンテンツ管理のためのREST API

一括記録操作。

post

/content/management/api/v1.1/items/{id}/metadata/transcripts/.bulk

一括記録操作。
リクエスト本文には、作成、更新、削除などのトランスクリプト操作が含まれます。
ペイロードの作成ブロックは、ノード・フィールドを使用して作成できるトランスクリプト・ノードのリストを受け入れます - start、end、text
ペイロードの更新ブロックは、フィールドを含むマージ・パッチ・ドキュメントのリストを受け入れます - id (必須)変更可能なフィールドを含めることができます - start、end、text
ペイロードの削除ブロックは、削除するノードのリストをフィールドとともに受け入れます - id (必須)。ヘッダー・プリファレンスの受入 - value respond-async。現在のジョブのステータスIDを持つバルク・トランスクリプト・ノード・ステータスAPIを指し示すhrefを持つロケーション・ヘッダーを返します。
これにより、フィールドID、開始、終了、テキストで作成ノードに作成されたノードを含むレスポンスが返され、リクエストされた場合はトランスクリプト・ノードへのリンク、更新されたノードおよびフィールドを含む更新バケットの影響を受けるノードが返されます - リクエストの一部として更新され、必要に応じてノードにリンクされます。
例外をエラー・コードとともにスロー -

CEC-CONTENT-TRANSCRIPT-022001(ファイル・タイプがトランスクリプト生成でサポートされていない場合)
ペイロードに不適切なトランスクリプト期間が指定されている場合のCEC-CONTENT-TRANSCRIPT-022002
ペイロードに無効な開始/終了時間書式が指定されている場合のCEC-CONTENT-TRANSCRIPT-022003
CEC-CONTENT-TRANSCRIPT-022004 (フィールドが正しくない場合)
ユーザーにエンタープライズ・ユーザー・ロールがない場合、またはユーザーがリポジトリに少なくともコントリビュータ・ロールを持っていない場合は、CEC-CONTENT-001004。

リクエスト

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

application/json

パス・パラメータ

id: string

アイテムのId。

ヘッダー・パラメータ

Prefer(optional): string

このパラメータは、リクエストの相互作用のタイプ(同期/非同期)を制御するために使用されます。ヘッダーの値がレスポンス/同期で指定されている場合は、非同期相互作用が優先されることを示します。それ以外の場合は、同期相互作用が優先されます。非同期リクエストは、ロケーション・ヘッダーにステータス・リンクがある202ステータスで応答します。同期リクエストは、レスポンス本文とともに200で応答します。

許容値: [ "respond-async" ]
X-Requested-With: string

CSRF攻撃を軽減するためのカスタム・ヘッダー。

許容値: [ "XMLHttpRequest" ]

一括記録操作。

ルート・スキーマ : BulkTranscriptOperations

型: object

記録一括操作

ソースを表示

create(optional): array create
delete(optional): array delete
links(optional): array links

読取り専用: true

バルク・ノード操作リソースへのリンク
update(optional): array update

{
    "type":"object",
    "properties":{
        "create":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Videotranscript"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"links to the bulk node operation resource",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Transcript Bulk Operations"
}

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

型: array

ソースを表示

Array of: object Videotranscript

ビデオ・トランスクリプト

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

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

型: array

ソースを表示

Array of: string

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

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

型: array

読取り専用: true

バルク・ノード操作リソースへのリンク

ソースを表示

Array of: object Link

リソースのリンク。

{
    "type":"array",
    "description":"links to the bulk node operation resource",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ソースを表示

Array of: object items

許可される追加のプロパティ: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

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

型: object

ビデオ・トランスクリプト

ソースを表示

end(optional): string

各トランスクリプト・ノードの終わり。
id(optional): string

各トランスクリプト・ノードのID。
links(optional): array links

リンク
start(optional): string

各トランスクリプト・ノードの開始。
text(optional): string

各成績証明書ノードのテキスト。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of each transcript node."
        },
        "start":{
            "type":"string",
            "description":"Start of each transcript node."
        },
        "end":{
            "type":"string",
            "description":"End of each transcript node."
        },
        "text":{
            "type":"string",
            "description":"Text of each transcript node."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Video transcript"
}

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

型: array

リンク

ソースを表示

Array of: object Link

リソースのリンク。

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

ネストされたスキーマ: 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."
}

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

型: object

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

ソースを表示

object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

型: object

トップに戻る

レスポンス

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

application/json

200レスポンス

OK。

202レスポンス

Accepted.

ルート・スキーマ : BulkTranscriptOperations

型: object

記録一括操作

ソースを表示

create(optional): array create
delete(optional): array delete
links(optional): array links

読取り専用: true

バルク・ノード操作リソースへのリンク
update(optional): array update

{
    "type":"object",
    "properties":{
        "create":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Videotranscript"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"links to the bulk node operation resource",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Transcript Bulk Operations"
}

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

型: array

ソースを表示

Array of: object Videotranscript

ビデオ・トランスクリプト

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

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

型: array

ソースを表示

Array of: string

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

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

型: array

読取り専用: true

バルク・ノード操作リソースへのリンク

ソースを表示

Array of: object Link

リソースのリンク。

{
    "type":"array",
    "description":"links to the bulk node operation resource",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ソースを表示

Array of: object items

許可される追加のプロパティ: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

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

型: object

ビデオ・トランスクリプト

ソースを表示

end(optional): string

各トランスクリプト・ノードの終わり。
id(optional): string

各トランスクリプト・ノードのID。
links(optional): array links

リンク
start(optional): string

各トランスクリプト・ノードの開始。
text(optional): string

各成績証明書ノードのテキスト。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of each transcript node."
        },
        "start":{
            "type":"string",
            "description":"Start of each transcript node."
        },
        "end":{
            "type":"string",
            "description":"End of each transcript node."
        },
        "text":{
            "type":"string",
            "description":"Text of each transcript node."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Video transcript"
}

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

型: array

リンク

ソースを表示

Array of: object Link

リソースのリンク。

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

ネストされたスキーマ: 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."
}

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

型: object

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

ソースを表示

object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

型: object

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

409レスポンス

競合

500レスポンス

内部サーバー・エラー

先頭に戻る