content library item: copy
Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task.
If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator.
A library item cannot be copied into a subscribed library.
|source_library_item_id||string||Identifier of the existing library item from which the content will be copied.|
Request Body Structure:
Request Body Parameters:
|bold = required|
|client_token||string|| Optional. A unique token generated on the client for each copy request. The token should be a universally unique identifier (UUID), for example:
|destination_create_spec||item_model||Specification for the new library item to be created.|
|destination_create_spec.id||string||A unique identifier for this library item. Optional. This field is not used for the
|destination_create_spec.library_id||string||The identifier of the content.library_model to which this item belongs. Optional. This field must be provided for the
|destination_create_spec.content_version||string||The version of the file content list of this library item. Optional. This field is not used for the
|destination_create_spec.creation_time||date_time||The date and time when this library item was created. Optional. This field is not used for the
|destination_create_spec.description||string||A human-readable description for this library item. Optional. This field is optional for the
|destination_create_spec.last_modified_time||date_time||The date and time when the metadata for this library item was last changed.
This field is affected by changes to the properties or file content of this item. It is not modified by changes to the tags of the item, or by changes to the library which owns this item.Optional. This field is not used for the
|destination_create_spec.last_sync_time||date_time||The date and time when this library item was last synchronized.
This field is updated every time a synchronization is triggered on the library item, including when a synchronization is triggered on the library to which this item belongs. The value is unset for a library item that belongs to a local library.Optional. This field is not used for the
|destination_create_spec.metadata_version||string||A version number for the metadata of this library item.
This value is incremented with each change to the metadata of this item. Changes to name, description, and so on will increment this value. The value is not incremented by changes to the content or tags of the item or the library which owns it.Optional. This field is not used for the
|destination_create_spec.name||string||A human-readable name for this library item.
The name may not be unset or an empty string. The name does not have to be unique, even within the same library.Optional. This field must be provided for the
|destination_create_spec.cached||boolean||The status that indicates whether the library item is on disk or not. The library item is cached when all its files are on disk. Optional. This field is not used for the
|destination_create_spec.size||long||The library item size, in bytes. The size is the sum of the size used on the storage backing for all the files in the item. When the library item is not cached, the size is 0. Optional. This field is not used for the
|destination_create_spec.type||string||An optional type identifier which indicates the type adapter plugin to use.
This field may be set to a non-empty string value that corresponds to an identifier supported by a type adapter plugin present in the Content Library Service. A type adapter plugin, if present for the specified type, can provide additional information and services around the item content. A type adapter can guide the upload process by creating file entries that are in need of being uploaded to complete an item.
The types and plugins supported by the Content Library Service can be queried using the content.type service.Optional. This field is optional for the
|destination_create_spec.version||string||A version number that is updated on metadata changes. This value is used to validate update requests to provide optimistic concurrency of changes.
This value represents a number that is incremented every time library item properties, such as name or description, are changed. It is not incremented by changes to the file content of the library item, including adding or removing files. It is also not affected by tagging the library item.Optional. This field is not used for the
|destination_create_spec.source_id||string||The identifier of the content.library.item_model to which this item is synchronized to if the item belongs to a subscribed library. The value is unset for a library item that belongs to a local library. Optional. This field is not used for the
HTTP Status Code: 200
|bold = required|
|value||string||The identifier of the new library item into which the content is being copied.|
|HTTP Status Code||Type||Description|
|404||not_found|| if the library item with
|400||invalid_argument|| if one of the following is true for the new library item:
|400||invalid_element_type|| if the content.library.item_model.library_id property of
|400||resource_inaccessible||if the copy operation failed because the source or destination library item is not accessible.|
|400||not_allowed_in_current_state|| if the content of the source library item specified by