事業体

POST /api/entities/{entityId}/copy

id=entityIdのエンティティをターゲットエンティティにコピーします。ターゲットエンティティは新しいエンティティでも既存のエンティティでも可能です。

リクエストの一般的な本文構造は以下の通りです:

{ // Identifier of a copy profile that could be used for copying of an entity "copy_profile_identifier": string

// Id of an entity that will be updated by copying values from an original entity "copy_profile_id": long?

// Id of an entity that will be updated by copying values from an original entity "destination_entity_id": long?

// Relations copy options "relation_copy_options":

{ // Relation name "relation": string

// Copy method "method": string

// Copy settings of related entities (the entire general structure) "related_copy_options": {} }

// Properties copy options: an array of properties configurations "property_copy_options":

{ // Property name "property": string

// Copy method "method": string

// New property value "new_value": string }

}

!重要

• すべてのパラメータは任意です。

• コピープロファイルのIDと識別子の両方を提供した場合、後者のみが考慮されます。

• プロパティまたはリレーションコピープロパティのいずれかを提供した場合、コピープロファイルのIDや識別子は考慮されません。

利用可能なリレーションコピー方法は以下の通りです:

• Keep - 同じ関連エンティティへの参照を作成する(同じIDを保持)。
• Remove - 空の関係(すべてのidを除去)を作成する。
• Copy - 関連するエンティティのコピーへの参照を作成する(関連するエンティティをコピーしリンクする)
• Overwrite - すべての参照を新しい参照に置き換え(新しいIDを設定する)
• Append - 既存の参照を保持しつつ新しい参照を追加する(既存の参照に新しいIDを追加する)
• Ignore - 関係をスキップし、宛先エンティティの元の値を保持します(ターゲットエンティティが新しいエンティティの場合、値はnullとなります)。

利用可能なプロパティコピー方法は以下の通りです:

• Keep - 元のエンティティの値をターゲットエンティティに適用する(デフォルト方式)
• Remove - ターゲットプロパティの値をnullに設定する。
• Overwrite - ターゲットプロパティの値を新しい値で上書きする。
• Ignore - 元のエンティティの値を無視し、ターゲットエンティティの値を保持します。

以下の例は異なるコピーリクエストを示しています。リクエストの構造は同一で、JSONペイロードの変更のみです。

POST http:///api/entities/{entityId}/copy Host: hostname Content-Type: application/json

例1

{ "property_copy_options": { "property": "BlockName", "method": "Overwrite", "new_value": "Block A" } , "relation_copy_options": { "relation": "BlockToTask", "method": "Copy", "related_copy_options": { "property_copy_options": { "property": "DoneDate", "method": "Remove" } , "relation_copy_options": { "relation": "TaskToAssetDeliverables", "method": "Remove" }

} }

}

例2

{ "copy_profile_id": 777, "destination_entity_id": 12345 }

例3

{ "copy_profile_identifier": "M.EntityCopyProfile.SomeProfile" }