1. REST API

一括編集ジョブ要求の作成

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

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

一括編集ジョブの作成リクエストオブジェクトは、新しい一括編集ジョブの作成をリクエストするために使用されます。次のプロパティが存在します。

名前

種類

形容

state_description

ラベル

一括編集ジョブの現在の状態の説明。

collection

徴収

処理する必要があるエンティティを決定するためにナビゲートするリレーションの詳細。

operations

配列

コレクション内のエンティティに対して実行する必要がある操作の一覧。

徴収

collectionプロパティは、処理されるエンティティを決定します。このプロパティには、次のプロパティを持つオブジェクトが含まれています。

名前

種類

形容

relation

リンク

ナビゲートするリレーションへのリンク。

role

リレーションをナビゲートするロールのタイプ。これは "Parent" または "Child" のいずれかです。

roleプロパティは、コレクションエンティティの側でのリレーションの役割を指定します。roleプロパティが "Parent" に設定されている場合、リレーションの子エンティティがナビゲートされます。同様に、roleプロパティが "Child" に設定されている場合、リレーションの親エンティティがナビゲートされます。

オペレーションズ

リスト内の各操作は、その操作で何を行う必要があるかを説明するオブジェクトです。

Set Property操作オブジェクト

プロパティの値を設定します (必要に応じて、特定のカルチャ用)。カルチャが指定されていない場合、値は、一度に複数のカルチャに設定する値を持つLabelsオブジェクトで構成されている必要があります。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

"SetProperty" に設定します。

property

設定するプロパティの名前

culture

必要に応じて、複数言語フィールドに値を設定するカルチャの名前。

value

価値

設定する値。

プロパティ操作オブジェクトを追加

プロパティの値を追加します (必要に応じて、特定のカルチャ用)。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

"AppendProperty" に設定

property

追加するプロパティの名前

culture

必要に応じて、複数言語フィールドに値を追加するカルチャの名前。

value

価値

追加する値。

リレーション操作オブジェクトをクリア

エンティティ上の特定のリレーションの関連メンバーを設定します。この処理が行われる前に、リレーションはクリアされます。これは、関連エンティティの順序が保持されることを保証している唯一の操作です。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

「ClearRelation」に設定

relation

クリアするリレーションの名前。

role

変更するロールのタイプ。「子」または「親」。

ロールはメイン エンティティを参照します。したがって、「子」ロールの場合、関連するエンティティは親または親であり、その逆も同様です。

リレーション操作オブジェクトを追加

エンティティ上の特定のリレーションに、関連するメンバーのセットを追加します。既に関連付けられているエンティティは影響を受けません。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

「AddRelation」に設定

relation

変更するリレーションの名前。

role

変更するロールのタイプ。「子」または「親」。

value

リンク または配列

リレーションに追加するエンティティを参照するLinkオブジェクトまたはLinkオブジェクトの配列。

ロールはメイン エンティティを参照します。したがって、「子」ロールの場合、関連するエンティティは親または親であり、その逆も同様です。

リレーション操作オブジェクトの削除

エンティティ上の特定のリレーションから、関連するメンバーのセットを削除します。リレーションの一部ではないエンティティは、操作に影響を与えません。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

"RemoveRelation" に設定

relation

変更するリレーションの名前。

role

変更するロールのタイプ。「子」または「親」。

value

リンク または配列

リレーションに追加するエンティティを参照するLinkオブジェクトまたはLinkオブジェクトの配列。

ロールはメイン エンティティを参照します。したがって、「子」ロールの場合、関連するエンティティは親または親であり、その逆も同様です。

送信操作オブジェクト

TBD

このタイプの操作が存在すると、通常の操作フローが自動的に無効になります。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

「送信」に設定

操作オブジェクトの承認

TBD

このタイプの操作が存在すると、通常の操作フローが自動的に無効になります。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

「承認」に設定

操作オブジェクトの拒否

TBD

このタイプの操作が存在すると、通常の操作フローが自動的に無効になります。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

「拒否」に設定

エンティティ操作オブジェクトの削除

エンティティを削除します。このタイプの操作が存在すると、通常の操作フローが自動的に無効になり、エンティティはすぐに削除されます。このオブジェクトには、次のプロパティがあります。

名前

種類

形容

type

"DeleteEntity" に設定

{
  "stateDescription":"In progress",
  "collection":{
    "relation":{
      "href":"http://server/api/entities/23/CollectionToAsset"    
    },
    "role":"Parent"
  },
  "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://server/api/entities/14"
        },
        {
          "href":"http://server/api/entities/14"
        }
      ]
    },
    {
      "type":"RemoveRelation",
      "relation":"AssetToAssetType",
      "role":"Child",
      "value":[
        {
          "href":"http://server/api/entities/14"
        }
      ]
    }
  ]
}
この記事を改善するための提案がある場合は、 お知らせください!