Asset management
The asset management capabilities of the API allow application developers to manage assets and relations and includes the following REST calls:
If you are retrieving information about a custom relationship that could be renamed,
or if you are retrieving system relationship names that have been localized, use the
relationship's ID number instead of the name. To get the IDs of all relationships,
use a call to /admin/relationtypes.
getAsset
|
Function |
Get all metadata for an asset. |
||
|
Description |
This request returns all of the metadata associated with an asset. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
(Mandatory) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a specific piece of metadata for an asset. |
||
|
Description |
This request returns a specific piece of metadata associated with an asset. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
For a list of attributes, use a call to admin/attributes. (Mandatory) |
|
|
|
string |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
|
boolean |
Returns the relation information of all child assets for the given asset. (Optional) |
|
|
|
boolean |
Returns the relation information of all parent assets for the given asset. (Optional) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
...with the URL:
Result:
...with the URL:
Result:
...with the URL:
Result:
|
||
|
Function |
Get a rendition of an asset. |
||
|
Description |
This request returns a particular rendition of an asset. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
|
Specify the required rendition type. (Optional) If the paramater is not passed the system returns the highres rendition type of the asset. Available renditions types are:
|
|
|
|
|
Specify layout ID in case of QuarkXPress document or CopyDesk article. (Optional) Layout only applies to a content type of QuarkPress, QuarkXPress Template , InDesign Document and InDesign Document Template. If this parameter is not passed it is defaulted to 1. |
|
|
|
|
Specify page in case of QuarkXPress document or CopyDesk article. (Optional) Page applies to all assets that have multi-page rendtions. If this parameter is not passed it is defaulted to 1. |
|
|
|
|
Controls whether the response body part displays inline (automatically upon receipt of the message). Defaults to inline. (Optional) |
|
|
|
long |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
Returns |
Returns a filestream of required assets based on given parameters. |
||
|
Examples |
URL:
Result: A filestream of a generated preview of the given asset. |
||
|
Function |
Get relationship with parent asset. |
||
|
Description |
This request allows you to fetch the information of an asset and its relationship to parent assets. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Parameter to fetch metadata of its parent assets. (Mandatory) |
|
|
|
long (relation type id) or string (relation type name) |
You can retrieve the list of relationship types with If not secified, the metadata related to all types of existing relations will be returned. The available relation types are:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: The |
||
|
Function |
Get relationship with child assets. |
||
|
Description |
This request allows you to fetch the information of an asset and its relationship to its child assets. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Parameter to fetch metadata of its child assets. (Mandatory) |
|
|
|
long (relation type id) or string (relation type name) |
You can retrieve the list of relationship types with If not secified, the metadata related to all types of existing relations will be returned. The available relation types are:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: The |
||
|
Function |
Get relationship with parent and child assets. |
||
|
Description |
This request allows you to retrieve an assets information and information about its relationship to parent and child assets. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
includeparents=true& includechildren=true |
boolean |
Specify if the relation metadata to parent assets or child assets is to be included or not. (Mandatory) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: The |
||
|
Function |
Get a Draft copy of an asset. |
||
|
Description |
This request returns a draft version of the required asset. If the draft doesn't exists, the last saved version of the asset will be returned. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
For a list of attributes, use a call to |
|
|
|
boolean |
(Mandatory) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
getAssetAllVersions
|
Function |
Get all attributes for all versions of an asset. |
||
|
Description |
This request returns all attributes for all versions of an asset. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
This operation will list all the metadata of all the versions. (Mandatory) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
importAsset
|
Function |
Import a new version of an existing asset. |
||
|
Description |
This request imports the new version of an asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request will insert an asset into the system without giving its stream. |
|
|
|
string |
The set of attribute values. See "Request/Response parameter formats."(Mandatory) |
|
|
|
boolean |
Defaults to |
|
|
|
boolean |
Defaults to |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: The |
||
importNewAsset
|
Function |
Import a new asset |
||
|
Description |
This request imports a new asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request will insert an asset into the system without giving its stream. |
|
|
|
string |
The set of attribute values. See "Request/Response parameter formats." (Mandatory) |
|
|
|
boolean |
Defaults to |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: The |
||
updateAsset
|
Function |
Update repository attributes. |
||
|
Description |
This requests updates the attribute values that are owned by a given repository adaptor. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The set of attribute values. S ee "Request/Response parameter formats."(Mandatory) |
|
|
|
GUID |
The repository token provided to the repository adaptor during repository adaptor registration. (Mandatory) |
|
|
|
long |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Update an asset's attributes. |
||
|
Description |
This request allows you to update attributes of specific version of an asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The set of attribute values. See "Request/Response parameter formats."(Mandatory) |
|
|
Returns |
Return an |
||
|
Examples |
URL:
Result:
|
||
duplicateAsset
|
Function |
Duplicate an asset |
||
|
Description |
This request creates a duplicate of an asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The set of attribute values. See "Request/Response parameter formats." The following attributes are Mandatory:
(There is a choice between collection ID, Name and Path when providing a value for the Collection attribute). |
|
|
|
boolean |
specify if the duplicated asset is to be created as a Major or Minor Version. Defaults to |
|
|
|
string or long |
You can retrieve the list of relationship types with |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: The |
||
deleteAsset
|
Function |
Delete an asset. |
||
|
Description |
This request deletes a specified asset from the QPP server. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request will lock the asset internally and delete it from system. |
|
|
|
long |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
|
boolean |
Indicates if all minor versions of the given asset version are to be deleted or not. If If |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createAssetRelation
|
Function |
Create a relationship between two assets. |
||
|
Description |
This request creates a relationship between two assets. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
createAssetRelation |
com.quark.qpp.service.facade Class AssetFacade |
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation requires parent asset to be in a Checked-Out state. |
|
|
|
long |
The ID of the other asset in the relationship. (Mandatory) |
|
|
|
long |
1 = primary attachment, 2 = secondary attachment. (Mandatory) The availabel relation types are:
|
|
|
|
string |
The set of attribute values. See "Request/Response parameter formats." For Secondary Attachment and Overlay Attachment the following attributes are Mandatory:
For Primary Attachment the following attribute is also Mandatory ins addition to the above mentioned four attributes:
For ArticleComponentRef Attachment the following two attributes are also Mandatory ins addition to the above mentioned four attributes:
|
|
|
|
long |
Specify the required childmajor and childminor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
|
boolean |
Defaults to false. Allows you to pin relationships to a particular version if true. (Optional) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
createAssetRelations
|
Function |
Create several relationships between an asset and other assets at one time. |
||
|
Description |
This request creates several relationships between an asset and other assets in a single request. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request requires that the parent asset to be in checked-out state. |
|
|
|
|
See "Request/Response parameter formats." (Mandatory) The The following is an example of creating several relationships at one time: Overlay Attachment:
Primary Attachment:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
getAssetRelations
|
Function |
Get metadata of the relations between two assets |
||
|
Description |
This request returns information about the relations between two assets. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
|
||
|
Examples |
URL:
Result:
|
||
updateAssetRelation
|
Function |
Update the relation type and attributes of a relationship. |
||
|
Description |
This request updates an asset relation with the given Id. In order to update the relation
type, specify |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request requires that the parent asset is in a checked-out state. |
|
|
|
long (relation type id) or string (relation type name) |
The new relation type. (Mandatory) |
|
|
|
string |
The set of relation attribute values. See "Request/Response parameter formats." For Secondary Attachment and Overlay Attachment the following attributes are Mandatory:
For Primary Attachment the following attribute is also Mandatory ins addition to the above mentioned four attributes: ATTACHED_COMPONENT_ID For ArticleComponent Ref Attachment the following two attributes are also Mandatory ins addition to the above mentioned four attributes:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
deleteAssetRelations
|
Function |
Delete a relationship by its id. |
||
|
Description |
This request deletes a specific relationship between two assets. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
deleteAssetRelations |
com.quark.qpp.service.facade Class AssetFacade |
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request requires that the parent asset is in a checked-out state. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
deleteAssetRelationsForParent
|
Function |
Delete an asset's relationship. |
||
|
Description |
This request removes all child relations of a specified asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request requires that the parent asset is in a checked-out state. |
|
|
|
long |
The ID of the child asset in the relationship to be deleted. (Optional) If this parameter is not supplied, all the asset's relation to its child assets will be deleted. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
generateTextIndexesOfAllAssets
|
Function |
Generate text indexes for all assets. |
||
|
Description |
This request asynchronously initiates text indexes for all Platform Server assets, including asset attributes and content. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution, along with the following message: The text indexes generation process has been initiated successfully. |
||
|
Examples |
URL:
|
||
generateTextIndexes
|
Function |
Generate text indexes for a specified asset. |
||
|
Description |
This requests initiates text indexes for a specified asset in Platform Server, including asset attributes and content.initiates. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long |
The ID of the asset. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getAssetVersionNumbers
|
Function |
Get a list of all versions of an asset. |
||
|
Description |
This request returns a list of versions for an asset. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
getAssetRenditionsInfo
|
Function |
Get information about an asset's renditions. |
||
|
Description |
This request returns all information about an asset's reditions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
By specifying rendition type, metadata of that rendition will be returned. (Optional) Available renditions are:
|
|
|
|
string |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
getAvailableRenditions
|
Function |
Get a list of an asset's available rendition types |
||
|
Description |
This request returns a list of all the rendition types that are applicatble to a specified asset. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
updateChildVersionForAsset
|
Function |
Update the version number of an asset's child asset. |
||
|
Description |
This request allows you to update the version number of an asset's child asset. The parent asset must be in a checked out state. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory)This operation requires parent asset to be in a Checked-Out state. |
|
|
|
long |
The ID of the child asset. (Mandatory) |
|
|
|
long |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
updateChildAssetVersionForRelationId
|
Function |
Update the version number of a relationship's child asset. |
||
|
Description |
This request updates a child asset toa given asset version for the given asset relation. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
updateChildAssetVersionForRelationId |
com.quark.qpp.service.facade Class AssetFacade |
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation requires the parent asset to be in a checked-out state. |
|
|
|
string |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
updateAllChildAssetsVersion
|
Function |
Update the version number of all of an asset's child assets to the parent asset's current version. |
||
|
Description |
Ths request allows you to update the asset versions of all the children of an asset at one time. the parent asset must be in a checked out state. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
updateAllChildAssetsVersion |
com.quark.qpp.service.facade Class AssetFacade |
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long (relation type id) or string (relation type name) |
You can retrieve the list of relationship types with /admin/relationtypes. (Optional) If the relation types are not specified, then the child asset version will be updated in all the relations with the given parent asset id. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
updateChildVersionLockingFlag
|
Function |
Update the "locked" flag for a child asset in a relationship. |
||
|
Description |
This request updates the lockedToChildVersion flag of the given Asset relation. |
||
|
Type |
POST |
||
|
URL Format |
.../assets/relations/[relation ID] |
||
|
Java API |
Method Name |
Class Name |
|
|
updateChildVersionLockingFlag |
com.quark.qpp.service.facade Class AssetFacade |
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
boolean |
True for locked, false for unlocked. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
checkIn
|
Function |
Check in a checked out asset. |
||
|
Description |
This request checks in a checked out asset. Include the file in the request body or as file part. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
checkIn |
com.quark.qpp.service.facade Class AssetFacade |
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request will not work if the asset is not checked out. |
|
|
|
|
See "Request/Response parameter formats." List of attribute values which need to be updated.
|
|
|
|
|
See "Request/Response parameter formats." If given a value in this request parameter, the Quark Publishing Platform Server will check-in a checked-out asset and create a relation with the secified parent asset at the same time. (Optional) For Secondary Attachment and Overlay Attachment the following attributes are Mandatory:
For Primary Attachment the following attribute is also Mandatory ins addition to the above mentioned four attributes:
For ArticleComponent Ref Attachment the following two attributes are also Mandatory ins addition to the above mentioned four attributes:
|
|
|
|
boolean |
Specify whether to create a minor version or not. Defaults to false. (Optional) |
|
|
Returns |
Returns the ass |
||
|
Examples |
URL:
Result: The |
||
checkInNew
|
Function |
Check in a new asset. |
||
|
Description |
Include the file in the request body or as file part. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
See "Request/Response parameter formats."
The following attributes are Mandatory:
|
|
|
|
|
See "Request/Response parameter formats." If this parameter is passed, the QPP Server will check-in the asset and create child relations with the new asset being checked in at the same time. (Optional). |
|
|
|
boolean |
Specify if this version of the asset is to be checked in to the QPP server as a major or a minor version. (Optional) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
checkInArticle
|
Function |
Check in a checked-out QuarkCopyDesk article with components. |
||
|
Description |
This request checks in a checked out article. Include the file in the request body or as file part. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request will not work if the asset is not checked out. |
|
|
|
|
See "Request/Response parameter formats." List of attribute values which need to be updated.
|
|
|
|
|
See "Request/Response parameter formats." If given a value in this request parameter, the Quark Publishing Platform Server will check-in a checked-out asset and create a relation with the secified parent asset at the same time. (Optional) |
|
|
|
boolean |
Specify whether to create a minor version or not. Defaults to false. (Optional) |
|
|
Returns |
Returns the assetInfo object of the latest version of the asset to be checked into the QPP server. |
||
|
Examples |
URL:
Result:
|
||
checkInNewArticle
|
Function |
Check in a new QuarkCopyDesk Article with components. |
||
|
Description |
Include the file in the request body or as file part. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
See "Request/Response parameter formats."
The following attributes are Mandatory:
|
|
|
|
|
See "Request/Response parameter formats." If this parameter is passed, the QPP Server will check-in the asset and create child relations with the new asset being checked in at the same time. (Optional). |
|
|
|
boolean |
Specify if this version of the asset is to be checked in to the QPP server as a major or a minor version. (Optional) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
checkInRendition
|
Function |
Check in a rendition of an asset. |
||
|
Description |
Include the file in the request body or as file part. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Specify the required rendition type. (Optional) If the paramater is not passed the system returns the highres rendition type of the asset.Available renditions types are:PREVIEWTHUMBNAILARTICLE_PAGE_PICTUREDECONSTRUCTED_XMLTEXT |
|
|
|
string |
The file extension of the rendition files being checked in. (Mandatory) |
|
|
|
long |
The number of pages contained in the rendition being created. (Optional) |
|
|
|
long |
Specify the required major and minor version for which the given rendition of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
checkOut
|
Function |
Check out an asset |
||
|
Description |
This request checks out the specified asset and returns its stream. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string in XML format |
See "Request/Response parameter formats."
The following attributes are Mandatory:
|
|
|
Returns |
Returns an asset stream after marking it checked out. |
||
|
Examples |
URL:
Result: An asset stream after marking it checked out. |
||
abortCheckout
|
Function |
Abort checkout of an asset |
||
|
Description |
This request aborts the check-out of an asset that is marked as checked-out. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request will not work if the asset is not checked out. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: The |
||
saveDraft
|
Function |
Saves the draft copy of an asset. |
||
|
Description |
This request saves the asset without creating a new version of the asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) Include the file in the request body or as file part. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
promoteDraft
|
Function |
Promotes the draft version to the actual version of an asset. |
||
|
Description |
This request saves the asset without creating a new version of the asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of attribute values to be set for this new asset version. For a list of attributes, use a call to admin/attributes. (Mandatory) |
|
|
|
string |
By default value is false. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
detectContentType
|
Function |
Detects content type of provided asset. Pass asset as stream in the request body. |
||
|
Description |
This request detects the content type of a provided asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The file extension of the asset. |
|
|
|
string |
The mime type of the asset. |
|
|
Returns |
|
||
|
Examples |
URL:
Result:
|
||
reIndex
|
Function |
Re-index an asset using the asset id. |
||
|
Description |
Re-indexes the given asset. It generates renditions of an asset such as previews, thumbnails, text renditions etc. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
|
Function |
Re-index an asset using the asset path. |
||
|
Description |
Re-indexes the given asset. It generates renditions of an asset such as previews, thumbnails, text renditions etc. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
