機械翻訳について

移動先

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

指定したアイテムにレンディションを追加します。

post

/content/management/api/v1.1/items/{id}/renditions

これは、ビデオとDigitalAssetTypeカテゴリのアイテムにのみ適用でき、インタラクションの非同期モードのみをサポート

リクエスト

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

• application/json

パス・パラメータ

• id: string
  アイテムのId。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

ヘッダー・パラメータ

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

  許容値: [ "XMLHttpRequest" ]

本文()

レンディションは、ペイロード内の指定された情報に基づいて追加されます。

ルート・スキーマ : rendition

型: object

rendition

ソースを表示

• formats(optional): array formats
  翻訳の形式
• links(optional): array links
  翻訳リソースのリンク
• name(optional): string
  翻訳の名前
• source(optional): object renditionSource
  renditionSource
• type(optional): string
  翻訳のタイプ

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the rendition"
        },
        "formats":{
            "type":"array",
            "description":"formats of the rendition",
            "items":{
                "$ref":"#/definitions/RenditionFormatBean"
            }
        },
        "type":{
            "type":"string",
            "description":"type of the rendition"
        },
        "links":{
            "type":"array",
            "description":"Links of rendition resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "source":{
            "description":"source details of rendition",
            "$ref":"#/definitions/renditionSource"
        }
    },
    "description":"rendition"
}

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

型: array

翻訳の形式

ソースを表示

• Array of: object RenditionFormatBean

{
    "type":"array",
    "description":"formats of the rendition",
    "items":{
        "$ref":"#/definitions/RenditionFormatBean"
    }
}

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

型: array

翻訳リソースのリンク

ソースを表示

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

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

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

型: object

renditionSource

ソースを表示

• externalId(optional): string
  externalId
• storageProvider(optional): string
  許容値: [ "kaltura" ]

  externalIdのソースstorageProvider

{
    "type":"object",
    "properties":{
        "storageProvider":{
            "type":"string",
            "description":"source storageProvider of the externalId",
            "enum":[
                "kaltura"
            ]
        },
        "externalId":{
            "type":"string",
            "description":"externalId"
        }
    },
    "description":"renditionSource"
}

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

型: object

ソースを表示

• format(optional): string
  format
• links(optional): array links
• metadata(optional): object Metadata
  メタデータ
• mimeType(optional): string
  翻訳形式のmimeType
• size(optional): integer(int32)
  size

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string",
            "description":"format"
        },
        "size":{
            "type":"integer",
            "format":"int32",
            "description":"size"
        },
        "mimeType":{
            "type":"string",
            "description":"mimeType of the rendition format"
        },
        "metadata":{
            "description":"metadata of the rendition format",
            "$ref":"#/definitions/Metadata"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

ソースを表示

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

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

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

型: object

メタデータ

ソースを表示

• height(optional): integer(int32)
  height
• width(optional): integer(int32)
  width

{
    "type":"object",
    "properties":{
        "width":{
            "type":"integer",
            "format":"int32",
            "description":"width"
        },
        "height":{
            "type":"integer",
            "format":"int32",
            "description":"height"
        }
    },
    "description":"Metadata"
}

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

トップに戻る

レスポンス

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

• application/json

202レスポンス

Accepted.

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

例:

次の例は、cURLを使用してRESTリソースでPOSTリクエストを発行して、アイテムにレンディションを追加する方法を示しています:

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/renditions'

これにより、外部ソースからアイテムに新しいレンディションが追加されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "renditionName",
  "source": {
    "externalId": "2342135",
    "storageProvider": "kaltura"
  }
}

リクエスト・ヘッダー

{
     "Content-Type": "application/json",
     "X-Requested-With": "XMLHttpRequest"
}

レスポンス・ヘッダー

{
   "Location": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/renditions/.status/205D91EAEEDD46E8AEF6065EDBD1BED2"
}

先頭に戻る