一括編集ジョブコレクション

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

一括編集ジョブ収集リソースには、システムに存在するすべての一括編集ジョブが含まれています。このリソースは、新しい一括編集ジョブのポストにも使用されます。サポートされている方法: GET、HEAD、POST

GET /api/massedits{?state,skip,take}

システム内のすべての一括編集ジョブのコレクションを含む一括編集ジョブ・コレクション・オブジェクトを返します。

必要に応じて、指定した状態に一致するジョブのみを返すstateフィルターを追加します。

チャンキング

1つのチャンクに収まりきらないほど多くのジョブがある場合は、次のチャンクを取得するためのリンクが含まれます。

まで

takeパラメータを使用して、指定した数のジョブ (最大100) を返します。skipパラメーターを使用して、返されるジョブの範囲をさらに決定します。

リクエストの例:

GET http://<hostname>/api/massedits?state=Pending
Host: hostname
Accept: application/json

応答の例:

HTTP/1.1 200 OK
Content-Length: content lengtha
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
    "items": [
        ... Mass Edit Job Objects
    ],
    "next",{
        "href":"http://<hostname>/api/massedits?skip=25"
    },
    "returned_items":25,
    "self":{
        "href":"http://<hostname>/api/massedits"
    },
    "total_items":78
}

POST /api/massedits

一括編集ジョブを作成します。本文には、完全なCreate Mass Edit Job Requestオブジェクトが必要です。成功は201 Created応答で示され、Locationヘッダーには新しく作成されたリソースのURLが含まれます。 masseditsエンドポイントを使用して、レンディションを更新したり、公開リンクを作成したりします。応答はすべての例で同じです。

標準的な一括編集のリクエストの例:

POST http://<hostname>/api/massedits

{
    "selectionPool": "SelectionPool.Content",
    "subPoolId": null,
    "definitionName": "M.Asset",
    "operations":[
        {
            "type":"SetProperty",
            "property":"AssetName",
            "culture":"en-US",
            "value":"New name for this asset."
        },
        {
            "type":"SetProperty",
            "property":"AssetTitle",
            "value":{
                "en-US":"New name for this asset.",
                "nl-BE":"De naam voor dit nieuwe asset."
            }
        },
        {
            "type":"ClearRelation",
            "relation":"AssetToAssetType",
            "role":"Child"
        },
        {
            "type":"AddRelation",
            "relation":"AssetToAssetType",
            "role":"Child",
            "value":[
                {
                    "href":"http://<hostname>/api/entities/14"
                },
                {
                    "href":"http://<hostname>/api/entities/15"
                }
            ]
        },
        {
            "type":"RemoveRelation",
            "relation":"AssetToAssetType",
            "role":"Child",
            "value":[
                {
                    "href":"http://<hostname>/api/entities/16"
                }
            ]
        }
    ]
}

更新レンディションの要求の例:

POST http://<hostname>/api/massedits

{
    "selectionPool": "SelectionPool.Content",
    "subPoolId": null,
    "definitionName": "M.Asset",
    "operations": [{
        "type": "RefreshRenditions",
        "value": {
            "renditions": [],
            "failed_only": false,
            "refresh_history": false,
            "refresh_subfiles": false,
            "refresh_user_renditions": false
        }
    }]
}

大量の公開リンクを作成するためのリクエストの例:

POST http://<hostname>/api/massedits

{
    "selectionPool": "SelectionPool.Content",
    "subPoolId": null,
    "definitionName": "M.Asset",
    "operations": [
        {
            "type": "CreatePublicLinks",
            "value": [
                {
                    "rendition": "downloadOriginal",
                    "expirationDate": null
                }
            ]
        }
    ]
}

応答の例:

HTTP/1.1 201 Created
Location: http://<hostname>/api/massedits/5549

この記事を改善するための提案がある場合は、お知らせください!