TransferCollectionItems.md

TransferCollectionItems

Properties

Name	Type	Required	Description
Ids	List<string>	✅	A list of collection request, response, or folder UIDs to transfer.
Mode_	Mode	✅	The transfer operation to perform.
Target_	Target	✅	Information about the item transfer's destination location.
Location_	Location	✅	The transferred items' placement in the target destination: - For start or end — Do not include the model and id values. - For before or after — Include the model and id properties.

Mode

The transfer operation to perform.

Properties

Name	Type	Required	Description
Copy	string	✅	"copy"
Move	string	✅	"move"

Target

Information about the item transfer's destination location.

Properties

Name	Type	Required	Description
Id	string	✅	The UID of the destination collection, folder, or request.
Model	TargetModel	✅	The collection, folder, or request the items will be transferred to. For response transfers, use the request value.

TargetModel

The collection, folder, or request the items will be transferred to. For response transfers, use the request value.

Properties

Name	Type	Required	Description
Collection	string	✅	"collection"
Folder	string	✅	"folder"
Request_	string	✅	"request"

Location

The transferred items' placement in the target destination: - For start or end — Do not include the model and id values. - For before or after — Include the model and id properties.

Properties

Name	Type	Required	Description
Position_	Position	✅	The transferred item's position within the destination object.
Id	string	❌	For before or after positions, the model's UID.
Model	string	❌	For before or after positions, the type of item (model) that the transferred item will be positioned by. One of: folder, request, or response.

Position

The transferred item's position within the destination object.

Properties

Name	Type	Required	Description
Start	string	✅	"start"
End	string	✅	"end"
Before	string	✅	"before"
After	string	✅	"after"