一括編集ジョブ作成要求オブジェクト
一括編集ジョブ作成要求オブジェクトは、新しい一括編集ジョブの作成を要求するために使用されます。 次のプロパティが存在します。
| 名前 | 型 | 説明 |
|---|---|---|
| state_description | ラベル | 一括編集ジョブの現在の状態の説明。 |
| collection | コレクション | 処理する必要のあるエンティティを特定するためにナビゲートするリレーションの詳細。 |
| operations | 配列 | コレクション内のエンティティに対して実行する必要のある操作のリスト。 |
コレクション
処理対象のエンティティは、collection プロパティによって決定します。 このプロパティには、次のプロパティを持つオブジェクトが含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| relation | リンク | ナビゲートするリレーションへのリンク。 |
| role | 文字列 | リレーションでナビゲートするロールのタイプ。 「Parent」または「Child」のいずれかになります。 |
role プロパティでは、コレクション エンティティ側のリレーションのロールを指定します。 role プロパティが「Parent」に設定されている場合、リレーションの子エンティティがナビゲートされます。 同様に、role プロパティが「Child」に設定されている場合、リレーションの親エンティティがナビゲートされます。
操作
リスト内の各操作はオブジェクトであり、その操作で実行する内容を示しています。
プロパティの設定操作オブジェクト
プロパティの値を設定します。オプションで特定のカルチャを指定します。 カルチャが指定されていない場合、一度に複数のカルチャに設定する値を持つラベル オブジェクトで、値が構成されている必要があります
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | 「SetProperty」に設定します。 |
| property | 文字列: | 設定するプロパティの名前。 |
| culture | 文字列 | (任意) 多言語フィールドに値を設定するカルチャの名前。 |
| value | 値 | 設定する値。 |
プロパティの追加操作オブジェクト
プロパティの値を追加します。オプションで特定のカルチャを指定します。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | 「AppendProperty」に設定します。 |
| property | 文字列 | 追加するプロパティの名前。 |
| culture | 文字列 | (任意) 多言語フィールドに値を追加するカルチャの名前。 |
| value | 値 | 追加する値。 |
リレーションのクリア操作オブジェクト
エンティティの特定のリレーションに関連するメンバーを設定します。 リレーションは、この処理が実行される前にクリアされます。 これは、関連するエンティティの順序が保持されることを保証する唯一の操作です。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | String | 「ClearRelation」に設定します。 |
| relation | 文字列 | クリアするリレーションの名前。 |
| role | 文字列 | 変更するロールのタイプ。 「Child」または「Parent」のいずれかになります。 |
ロールは主要なエンティティを参照します。 そのため、「Child」ロールの場合、関連するエンティティは 1 つ以上の親であり、その逆も同様です。
リレーションの追加操作オブジェクト
関連する一連のメンバーをエンティティの特定のリレーションに追加します。 すでに関連しているエンティティは影響を受けません。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | 「AddRelation」に設定します。 |
| relation | 文字列 | 変更するリレーションの名前。 |
| role | 文字列 | 変更するロールのタイプ。 「Child」または「Parent」のいずれかになります。 |
| value | リンクまたは配列 | リレーションに追加するエンティティを参照するリンク オブジェクトまたはリンク オブジェクトの配列。 |
ロールは主要なエンティティを参照します。 そのため、「Child」ロールの場合、関連するエンティティは 1 つ以上の親であり、その逆も同様です。
リレーションの削除操作オブジェクト
関連する一連のメンバーをエンティティの特定のリレーションから削除します。 リレーションの一部ではないエンティティは、操作に影響を与えません。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | 「RemoveRelation」に設定します。 |
| relation | 文字列 | 変更するリレーションの名前。 |
| role | 文字列 | 変更するロールのタイプ。 「Child」または「Parent」のいずれかになります。 |
| value | リンクまたは配列 | リレーションに追加するエンティティを参照するリンク オブジェクトまたはリンク オブジェクトの配列。 |
ロールは主要なエンティティを参照します。 そのため、「Child」ロールの場合、関連するエンティティは 1 つ以上の親であり、その逆も同様です。
送信操作オブジェクト
TBD
このタイプの操作が存在する場合、通常の操作フローが自動的に無効になります。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | 「Submit」に設定します。 |
承認操作オブジェクト
TBD
このタイプの操作が存在する場合、通常の操作フローが自動的に無効になります。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | 「Approve」に設定します。 |
拒否操作オブジェクト
TBD
このタイプの操作が存在する場合、通常の操作フローが自動的に無効になります。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | 「Reject」に設定します。 |
エンティティの削除操作オブジェクト
エンティティを削除します。 このタイプの操作が存在する場合、通常の操作フローが自動的に無効になり、ただちにエンティティが削除されます。
プロパティ:
| 名前 | 型 | 説明 |
|---|---|---|
| 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"
}
]
}
]
}