Skip to main content

TransferCollectionItems

Properties

NameTypeRequiredDescription
idsstring[]A list of collection request, response, or folder UIDs to transfer.
modeModeThe transfer operation to perform.
targetTargetInformation about the item transfer's destination location.
locationLocationThe 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

NameTypeRequiredDescription
COPYstring"copy"
MOVEstring"move"

Target

Information about the item transfer's destination location.

Properties

NameTypeRequiredDescription
idstringThe UID of the destination collection, folder, or request.
modelTargetModelThe 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

NameTypeRequiredDescription
COLLECTIONstring"collection"
FOLDERstring"folder"
REQUESTstring"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

NameTypeRequiredDescription
positionPositionThe transferred item's position within the destination object.
idstringFor before or after positions, the model's UID.
modelstringFor 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

NameTypeRequiredDescription
STARTstring"start"
ENDstring"end"
BEFOREstring"before"
AFTERstring"after"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →