Rest Interface Guide

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

attributes=all

string

(Mandatory)

Returns

Returns an assetInfo object with the metadata of all attributes.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?attributes=all

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
    <assetVersion minorVersion="1" majorVersion="0"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
      <attributeValue type="text" name="Name" id="2">1quark2.jpg</attributeValue>
      ....
    </attributeValueList>
  </assetInfo>

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

attributes= [comma-separated list of attribute names or IDs]

string

For a list of attributes, use a call to admin/attributes. (Mandatory)

majorversion and minorversion

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.

includechildren

boolean

Returns the relation information of all child assets for the given asset. (Optional)

includeparents

boolean

Returns the relation information of all parent assets for the given asset. (Optional)

Returns

Returns an assetInfo object with the metadata of specified attributes.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?attributes=1,name,3,4,5,6,7,8,54,collection

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
    <assetVersion minorVersion="1" majorVersion="0"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
      ....
    </attributeValueList>
  </assetInfo>

...with the majorversion and minorversion parameters

URL:

http://serverName:serverPort/rest/service/assets/292?attributes=1,name,3,4,5,6,7,8,54,collection&majorversion=1&minorversion=0

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="292">
    <assetVersion minorVersion="0" majorVersion="1"/>
    <attributeValueList>
      <attributeValue valueId="0" type="numeric" name="Id" id="1">292</attributeValue>
      <attributeValue valueId="0" type="text" name="Name" id="2">15116462.qxp</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Created" id="3">2013-10-16T11:48:52Z</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-10-16T11:54:56Z</attributeValue>
      <attributeValue valueId="1" type="popup" name="Creator" id="5">Admin</attributeValue>
      <attributeValue valueId="1" type="popup" name="Last modifier" id="6">Admin</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Major version" id="7">1</attributeValue>
      <attributeValue valueId="0" type="text" name="File path" id="8">/01/24/292.1-0.1.1.qxp</attributeValue>
      <attributeValue valueId="10" type="popup" name="Workflow" id="54">Workflow1</attributeValue>
      <attributeValue valueId="1" type="popup" name="Collection" id="55">Home</attributeValue>
    </attributeValueList>
  </assetInfo>

...with the includechildren parameter

URL:

http://serverName:serverPort/rest/service/assets/292?attributes=1,name,3,4,5,6,7,8,54,collection&includechildren=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="292">
    <assetVersion minorVersion="0" majorVersion="1"/>
    <attributeValueList>
      <attributeValue valueId="0" type="numeric" name="Id" id="1">292</attributeValue>
      <attributeValue valueId="0" type="text" name="Name" id="2">15116462.qxp</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Created" id="3">2013-10-16T11:48:52Z</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-10-16T11:54:56Z</attributeValue>
      <attributeValue valueId="1" type="popup" name="Creator" id="5">Admin</attributeValue>
      <attributeValue valueId="1" type="popup" name="Last modifier" id="6">Admin</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Major version" id="7">1</attributeValue>
      <attributeValue valueId="0" type="text" name="File path" id="8">/01/24/292.1-0.1.1.qxp</attributeValue>
      <attributeValue valueId="10" type="popup" name="Workflow" id="54">Workflow1</attributeValue>
      <attributeValue valueId="1" type ="popup" name="Collection" id="55">Home</attributeValue>
    </attributeValueList>
    <assetRelationInfoList>
      <assetRelationInfo relationStateId="1" relationState="Permanent" relationTypeId="1" relationType="Primary Attachment" childAssetMinorVersion="2" childAssetMajorVersion="0" childAssetName="153486e3.qcd" childAssetId="290" parentAssetName="15116462.qxp" parentAssetId="292" id="109">
      <attributeValueList>
        <attributeValue valueId="0" type="numeric" name="Attached Layout Uid" id="401">1</attributeValue>
        <attributeValue valueId="0" type="numeric" name="Box Uid" id="402">5</attributeValue>
        <attributeValue valueId="0" type="text" name="Page Name" id="403">Page 1</attributeValue>
        <attributeValue valueId="0" type="numeric" name="Page Index" id="404">0</attributeValue>
        <attributeValue valueId="0" type="numeric" name="Attached Component Id" id="412">136</attributeValue>
      </attributeValueList>
    </assetRelationInfo>
  </assetRelationInfoList>
</assetInfo>

...with the includechildren and includeparents parameters

URL:

http://serverName:serverPort/rest/service/assets/290?attributes=1,name,3,4,5,6,7,8,54,collection&includechildren=true&includeparents=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="290">
    <assetVersion minorVersion="2" majorVersion="0"/>
    <attributeValueList>
      <attributeValue valueId="0" type="numeric" name="Id" id="1">290</attributeValue>
      <attributeValue valueId="0" type="text" name="Name" id="2">153486e3.qcd</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Created" id="3">2013-10-16T11:48:14Z</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-10-16T11:54:57Z</attributeValue>
      <attributeValue valueId="1" type="popup" name="Creator" id="5">Admin</attributeValue>
      <attributeValue valueId="1" type="popup" name="Last modifier" id="6">Admin</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Major version" id="7">0</attributeValue>
      <attributeValue valueId="0" type="text" name="File path" id="8">/01/22/290.0-2.1.1.qcd</attributeValue>
      <attributeValue valueId="10" type="popup" name="Workflow" id="54">Workflow1</attributeValue>
      <attributeValue valueId="1" type="popup" name="Collection" id="55">Home</attributeValue>
    </attributeValueList>
    <assetRelationInfoList>
      <assetRelationInfo relationStateId="1" relationState="Permanent" relationTypeId="4" relationType="Article Component Reference" childAssetMinorVersion="1" childAssetMajorVersion="0" childAssetName="Picture2850.jpg" childAssetId="291" parentAssetName="153486e3.qcd" parentAssetId="290" id="108">
        <attributeValueList>
          <attributeValue valueId="0" type="numeric" name="Attached Component Id" id="412">136</attributeValue>
          <attributeValue valueId="0" type="numeric" name="Article Component id" id="305">2</attributeValue>
          <attributeValue valueId="0" type="numeric" name="Article Id" id="413">290</attributeValue>
        </attributeValueList>
      </assetRelationInfo>
      <assetRelationInfo relationStateId="1" relationState="Permanent" relationTypeId="1" relationType="Primary Attachment" childAssetMinorVersion="2" childAssetMajorVersion="0" childAssetName="153486e3.qcd" childAssetId="290" parentAssetName="15116462.qxp" parentAssetId="292" id="109">
        <attributeValueList>
          <attributeValue valueId="0" type="numeric" name="Attached Layout Uid" id="401">1</attributeValue>
          <attributeValue valueId="0" type="numeric" name="Box Uid" id="402">5</attributeValue>
          <attributeValue valueId="0" type="text" name="Page Name" id="403">Page 1</attributeValue>
          <attributeValue valueId="0" type="numeric" name="Page Index" id="404">0</attributeValue>
          <attributeValue valueId="0" type="numeric" name="Attached Component Id" id="412">136</attributeValue>
        </attributeValueList>
      </assetRelationInfo>
    </assetRelationInfoList>
  </assetInfo>

Function

Get a rendition of an asset.

Description

This request returns a particular rendition of an asset.

Type

GET

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

rendition=highres or rendition=1

 

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:

  • HIGHRES

  • PREVIEW

  • THUMBNAIL

  • ARTICLE_PAGE_PICTURE

  • DECONSTRUCTED_XML

  • TEXT

layout=1

 

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.

page=2

 

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.

contentDisposition =[option]

 

Controls whether the response body part displays inline (automatically upon receipt of the message). Defaults to inline. (Optional)

majorversion=[x] and minorversion=[x]

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:

http://serverName:serverPort/rest/service/assetsbypath/Home/15116.qxp?rendition=preview

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

includeparents=true

boolean

Parameter to fetch metadata of its parent assets. (Mandatory)

relationtypes=[comma-separated list of relationship names or IDs]

long (relation type id) or string (relation type name)

You can retrieve the list of relationship types with /admin/relationtypes. (Optional)

If not secified, the metadata related to all types of existing relations will be returned.

The available relation types are:

  • Primary Attachment

  • Secondary Attachment

  • Article Component Ref Attachment

  • Overlay Attachment

  • XML Component Reference

  • InDesign Behavior Reference

  • InDesinn Hyperlink Reference

Returns

Returns an assetInfo object containing metadata of the relationship to the parent assets.

Examples

URL:

http://serverName:serverPort/rest/service/assets/[asset id]?includeparents=true

Result:

The assetInfoobject containing metadata of the relationship to the parent assets.

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

includechildren=true

boolean

Parameter to fetch metadata of its child assets. (Mandatory)

relationtypes =[comma-separated list of relationship names or IDs]

long (relation type id) or string (relation type name)

You can retrieve the list of relationship types with /admin/relationtypes. (Optional)

If not secified, the metadata related to all types of existing relations will be returned.

The available relation types are:

  • Primary Attachment

  • Secondary Attachment

  • Article Component Ref Attachment

  • Overlay Attachment

  • XML Component Reference

  • InDesign Behavior Reference

  • InDesinn Hyperlink Reference

Returns

Returns an assetRelationInfoList. object containing metadata of relations to parent and child assets. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/assets/[asset id]?includechildren=true

Result:

The assetInfo object containing metadata of the relationship to child assets.

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAsset

com.quark.qpp.service.facade Class AssetFacade

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 assetRelationInfoList. object containing metadata of relations to parent and child assets. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/assets/[assetid]?includechildren=true&includeparents=true

Result:

The assetInfo object containing metadata of relations to parent and child assets.

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

attributes= [comma-separated list of attribute names or IDs]

string

For a list of attributes, use a call to admin/attributes. (Mandatory)

draft=[true]

boolean

(Mandatory)

Returns

Returns an assetInfo object with the metadata of all attributes.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?attributes=all&draft=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
    <assetVersion minorVersion="1" majorVersion="0"/>
    <attributeValueList>
     <attributeValue type="numeric" name="Id "id="1">4</attributeValue>
     <attributeValue type="text" name="Name" id="2">1quark2.jpg</attributeValue>
     ....
    </attributeValueList>
  </assetInfo>

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAssetAllVersions

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=allversions

string

This operation will list all the metadata of all the versions. (Mandatory)

Returns

Returns an assetInfoList object containg an array of all versions of the same asset with all of its' metadata. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?op=allversions

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfoList>
    <assetInfo id="4"assetVersion minorVersion="1"majorVersion="0"/>
      <attributeValueList>
        <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
        ....
      </attributeValueList>
    </assetInfo>
    <assetInfo id="4" assetVersion minorVersion="2" majorVersion="0"/>
      <attributeValueList>
        <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
        ....
      </attributeValueList>
    </assetInfo>
 </assetInfoList>

importAsset

Function

Import a new version of an existing asset.

Description

This request imports the new version of an asset.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

importAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=import

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.

attributevalues=<xml/>

string

The set of attribute values.

See "Request/Response parameter formats."(Mandatory)

createminorversion =[true|false]

boolean

Defaults to false.(Optional)

index=[true|false]

boolean

Defaults to true.(Optional)

Returns

Returns an assetInfo object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/[asset name]?op=import

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
  <assetVersion minorVersion="1" majorVersion="0"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
      <attributeValue type="text" name="Name" id="2">1quark2.jpg</attributeValue>
      ....
    </attributeValueList>
  </assetInfo>

Result:

The assetInfo object in XML format.

importNewAsset

Function

Import a new asset

Description

This request imports a new asset.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[asset name]

Java API

Method Name

Class Name

importNewAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=importnew

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.

attributevalues=<xml/>

string

The set of attribute values.

See "Request/Response parameter formats." (Mandatory)

index=[true|false]

boolean

Defaults to true. (Optional)

Returns

Returns an assetInfo object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/[asset name]?op=importnew

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
  <assetVersion minorVersion="1" majorVersion="0"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
      <attributeValue type="text" name="Name" id="2">1quark2.jpg</attributeValue>
      ....
    </attributeValueList>
  </assetInfo>

Result:

The assetInfo object in XML format.

updateAsset

Function

Update repository attributes.

Description

This requests updates the attribute values that are owned by a given repository adaptor.

Type

POST

URL Format

.../assets/[asset id]?op=update&repotoken=[repo token]&attributes=....

Java API

Method Name

Class Name

updateAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=update

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

attributes=<xml/>

string

The set of attribute values. S

ee "Request/Response parameter formats."(Mandatory)

repotoken=[token]

GUID

The repository token provided to the repository adaptor during repository adaptor registration. (Mandatory)

majorversion=[x] and minorversion=[x]

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 assetInfo object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/assets/24?op=update&attributevalues=

<attributeValueList>
   <attributeValue name="name">blag_new</attributeValue>
   <attributeValue name="status">Status2</attributeValue>
   <attributeValue name="workflow">Workflow2</attributeValue>
  </attributeValueList>
&repotoken=[repository token]

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
    <assetVersion minorVersion="1" majorVersion="0"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
      <attributeValue type="text" name="Name" id="2">1quark2.jpg</attributeValue>
      ....
    </attributeValueList>
  </assetInfo>

Function

Update an asset's attributes.

Description

This request allows you to update attributes of specific version of an asset.

Type

POST

URL Format

/assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

updateAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=update

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

attributevalues=<xml/>

string

The set of attribute values.

See "Request/Response parameter formats."(Mandatory)

Returns

Return an assetInfo object of the specified asset with updated metadata.

Examples

URL:

http://serverName:serverPort/rest/service/assets/[parent asset id]?op=update&attributevalues=

<attributeValueList>
   <attributeValue name="name">blag_new</attributeValue>
   <attributeValue name="status">Status2</attributeValue>
   <attributeValue name="workflow">Workflow2</attributeValue>
  </attributeValueList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
    <assetVersion minorVersion="1" majorVersion="0"/>     <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
      <attributeValue type="text" name="Name" id="2">1quark2.jpg</attributeValue>
      ....
    </attributeValueList>
 </assetInfo>

duplicateAsset

Function

Duplicate an asset

Description

This request creates a duplicate of an asset.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

duplicateAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=duplicate

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

attributevalues=<xml/>

string

The set of attribute values.

See "Request/Response parameter formats."

The following attributes are Mandatory:

  • NAME

  • COLLECTION

(There is a choice between collection ID, Name and Path when providing a value for the Collection attribute).

createminorversion =[true|false]

boolean

specify if the duplicated asset is to be created as a Major or Minor Version.

Defaults to false. (Optional)

relationtypes =[comma-separated list of relationship names or IDs]

string or long

You can retrieve the list of relationship types with /admin/relationtypes. (Optional)

Returns

Returns an assetInfo object of the newly created asset in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?op=duplicate&attributevalues=

 <attributeValueList>
   <attributeValue name="name">Duplicate_asset</attributeValue>
   <attributeValue name="collection">1</attributeValue>
  </attributeValueList>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="11">
   <assetVersion minorVersion="0" majorVersion="1"/>
   <attributeValueList>
    <attributeValue type="numeric" name="Id" id="1">11</attributeValue>
    <attributeValue type="text" name="Name" id="2">Duplicate_asset</attributeValue>
    ....
   </attributeValueList>
  </assetInfo>

Result:

The assetInfo object of the newly created asset in XML format.

deleteAsset

Function

Delete an asset.

Description

This request deletes a specified asset from the QPP server.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

deleteAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=delete

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.

majorversion=[x] and minorversion=[x]

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.

deleteminorver=True/False

boolean

Indicates if all minor versions of the given asset version are to be deleted or not.

If True - all minor versions (associated with the given major version) of the asset would also be deleted.

If False, only the specified version will be deleted. This parameter would be considered only when the given asset version is major. (Mandatory)

Returns

A status of 200 is returned in response to a successful request execution.

Examples

URL:

http://serverName:serverPort/rest/service/assets/25?op=delete

createAssetRelation

Function

Create a relationship between two assets.

Description

This request creates a relationship between two assets.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

createAssetRelation

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=createrelation

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.

childassetid=[asset id]

long

The ID of the other asset in the relationship. (Mandatory)

relationtype=[x]

long

1 = primary attachment, 2 = secondary attachment. (Mandatory)

The availabel relation types are:

  • Primary Attachment

  • Secondary Attachment

  • Article Component Ref Attachment

  • Overlay Attachment

  • XML Component Reference

  • InDesign Behavior Reference

  • InDesinn Hyperlink Reference

attributevalues=<xml/>

string

The set of attribute values.

See "Request/Response parameter formats."

For Secondary Attachment and Overlay Attachment the following attributes are Mandatory:

  • ATTACHED_LAYOUT_ID

  • BOX_ID

  • PAGE_NAME

  • PAGE_INDEX

For Primary Attachment the following attribute is also Mandatory ins addition to the above mentioned four attributes:

  • ATTACHED_COMPONENT_ID

For ArticleComponentRef Attachment the following two attributes are also Mandatory ins addition to the above mentioned four attributes:

  • ARTICLE_ID

  • ARTICLE_COMPONENT_ID

childmajorversion=[x] and childminorversion=[x]

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.

lockedtochildversion =[true|false]

boolean

Defaults to false. Allows you to pin relationships to a particular version if true. (Optional)

Returns

Returns an assetRelationInfo object containing metadata of the relation, parent and child asset. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/assets/[parent asset Id]?op=createrelation&childassetid=[child asset Id]&relationtype=Secondary Attachment&attributevalues=

<attributeValueList>
  <attributeValue id="401">1</attributeValue>
  <attributeValue id="402">5</attributeValue>
  <attributeValue id="403">1</attributeValue>
  <attributeValue id="404">1</attributeValue>
  <attributeValue id="412">1</attributeValue>
</attributeValueList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetRelationInfo
   relationStateId="3"
   relationState="Related Temporarily"
   relationTypeId="2"
   relationType="Secondary Attachment"
   childAssetMinorVersion="2"
   childAssetMajorVersion="0"
   childAssetName="1quark2.jpg"
   childAssetId="4"
   parentAssetName="15116.qxp"
   parentAssetId="5"
   id="13">
    <attributeValueList>
      <attributeValue type="numeric" name="Attached Layout Uid" id="401">1</attributeValue>
      <attributeValue type="numeric" name="Box Uid" id="402">5</attributeValue>
      <attributeValue type="text" name="Page Name" id="403">1</attributeValue>
      <attributeValue type="numeric" name="Page Index" id="404">1</attributeValue>
      <attributeValue type="numeric" name="Attached Component Id" id="412">1</attributeValue>
    </attributeValueList>
  </assetRelationInfo>

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

.../assetsbypath or /assets

Java API

Method Name

Class Name

createAssetRelations

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=createrelations

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.

relations=<xml/>

 

See "Request/Response parameter formats." (Mandatory)

The relationInfoList returned will contain the metadata of all the relations that have to be created.

The following is an example of creating several relationships at one time:

Overlay Attachment:

<?xml version="1.0" encoding="UTF-8"?>
<assetRelationInfoList>
    <assetRelationInfo id="112" parentAssetId="306" parentAssetName="15116d33.qxp" childAssetId="307" childAssetName="Picture2503.jpg" childAssetMinorVersion="1" relationType="Overlay Attachment" relationTypeId="3" relationState="Related Temporarily" relationStateId="3">
        <attributeValueList>
            <attributeValue id="401" name="Attached Layout Uid" type="numeric">1</attributeValue>
            <attributeValue id="402" name="Box Uid" type="numeric">17</attributeValue>
            <attributeValue id="403" name="Page Name" type="text">Page 1</attributeValue>
            <attributeValue id="404" name="Page Index" type="numeric">0</attributeValue>
        </attributeValueList>
    </assetRelationInfo>
    <assetRelationInfo id="113" parentAssetId="306" parentAssetName="15116d33.qxp" childAssetId="308" childAssetName="Picture2aba.jpg" childAssetMinorVersion="1" relationType="Overlay Attachment" relationTypeId="3" relationState="Related Temporarily" relationStateId="3">
        <attributeValueList>
            <attributeValue id="401" name="Attached Layout Uid" type="numeric">1</attributeValue>
            <attributeValue id="402" name="Box Uid" type="numeric">17</attributeValue>
            <attributeValue id="403" name="Page Name" type="text">Page 1</attributeValue>
            <attributeValue id="404" name="Page Index" type="numeric">0</attributeValue>
        </attributeValueList>
    </assetRelationInfo>
    <assetRelationInfo id="114" parentAssetId="306" parentAssetName="15116d33.qxp" childAssetId="309" childAssetName="Picture2810.jpg" childAssetMinorVersion="1" relationType="Overlay Attachment" relationTypeId="3" relationState="Related Temporarily" relationStateId="3">
        <attributeValueList>
            <attributeValue id="401" name="Attached Layout Uid" type="numeric">1</attributeValue>
            <attributeValue id="402" name="Box Uid" type="numeric">17</attributeValue>
            <attributeValue id="403" name="Page Name" type="text">Page 1</attributeValue>
            <attributeValue id="404" name="Page Index" type="numeric">0</attributeValue>
        </attributeValueList>
    </assetRelationInfo>
    <assetRelationInfo id="115" parentAssetId="306" parentAssetName="15116d33.qxp" childAssetId="310" childAssetName="Picture225d.jpg" childAssetMinorVersion="1" relationType="Overlay Attachment" relationTypeId="3" relationState="Related Temporarily" relationStateId="3">
        <attributeValueList>
            <attributeValue id="401" name="Attached Layout Uid" type="numeric">1</attributeValue>
            <attributeValue id="402" name="Box Uid" type="numeric">17</attributeValue>
            <attributeValue id="403" name="Page Name" type="text">Page 1</attributeValue>
            <attributeValue id="404" name="Page Index" type="numeric">0</attributeValue>
        </attributeValueList>
    </assetRelationInfo>
    <assetRelationInfo id="116" parentAssetId="306" parentAssetName="15116d33.qxp" childAssetId="311" childAssetName="Picture24da.jpg" childAssetMinorVersion="1" relationType="Overlay Attachment" relationTypeId="3" relationState="Related Temporarily" relationStateId="3">
        <attributeValueList>
            <attributeValue id="401" name="Attached Layout Uid" type="numeric">1</attributeValue>
            <attributeValue id="402" name="Box Uid" type="numeric">17</attributeValue>
            <attributeValue id="403" name="Page Name" type="text">Page 1</attributeValue>
            <attributeValue id="404" name="Page Index" type="numeric">0</attributeValue>
        </attributeValueList>
    </assetRelationInfo>
</assetRelationInfoList>

Primary Attachment:

<?xml version="1.0" encoding="UTF-8"?>
<assetRelationInfoList>
    <assetRelationInfo parentAssetId="304" childAssetId="305" relationType="Primary Attachment">
        <attributeValueList>
            <attributeValue id="401">1</attributeValue>
            <attributeValue id="402">5</attributeValue>
            <attributeValue id="403">Page 1</attributeValue>
            <attributeValue id="404">0</attributeValue>
            <attributeValue id="412">145</attributeValue>
        </attributeValueList>
    </assetRelationInfo>
</assetRelationInfoList>

Returns

Returns an assetRelationInfo object containing metadata of the relation, parent and child asset. See the table in the "RequestResponse parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/assets/[parent asset id]?op=createrelations

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>   <assetRelationInfoList>
   <assetRelationInfo relationStateId="3"
    relationState="Related Temporarily"
    relationTypeId="2"
    relationType="Secondary Attachment"
    childAssetMinorVersion="2"
    childAssetMajorVersion="0"
    childAssetName="1quark2.jpg"
    childAssetId="4"
    parentAssetName="15116.qxp"
    parentAssetId="24"
    id="14">
     <attributeValueList>
      <attributeValue type="numeric" name="Attached Layout Uid" id="401">1</attributeValue>
      <attributeValue type="numeric" name="Box Uid" id="402">5</attributeValue>
      <attributeValue type="text" name="Page Name" id="403">1</attributeValue>
      <attributeValue type="numeric" name="Page Index" id="404">1</attributeValue>
      <attributeValue type="numeric" name="Attached Component Id" id="412">1</attributeValue>
     </attributeValueList>
   </assetRelationInfo>
  </assetRelationInfoList>

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

.../assetsbypath/relations/[RelationId] or /assets/relations/[RelationId]

Java API

Method Name

Class Name

getAssetRelations

com.quark.qpp.service.facade Class AssetFacade

Parameters

This request requires no input parameters.

Returns

 

Examples

URL:

http://serverName:serverPort/rest/service/assets/relations/1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>   <assetRelationInfo
   relationStateId="1"
   relationState="Permanent"
   relationTypeId="1"
   relationType="Primary Attachment"
   childAssetMinorVersion="1"
   childAssetMajorVersion="0"
   childAssetName="15348eb3.qcd"
   childAssetId="51"
   parentAssetName="15116bb0.qxp"
   parentAssetId="50" id="1">
    <attributeValueList>
      <attributeValue valueId="0" type="numeric" name="Attached Layout Uid" id="401">1</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Box Uid" id="402">5</attributeValue>
      <attributeValue valueId="0" type="text" name="Page Name" id="403">Page 1</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Page Index" id="404">0</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Attached Component Id" id="412">10</attributeValue>
    </attributeValueList>
  </assetRelationInfo>

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 newRelationType and the corresponding attributes to be set. If the relation type is not supplied then it will update only the relation attributes for the current relation type of the given relation.

Type

POST

URL Format

.../assets/relations/[relation ID]

Java API

Method Name

Class Name

updateAssetRelation

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=update

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.

relationtype=[relation type name or ID]

long (relation type id) or string (relation type name)

The new relation type. (Mandatory)

attributevalues=<xml/>

string

The set of relation attribute values.

See "Request/Response parameter formats."

For Secondary Attachment and Overlay Attachment the following attributes are Mandatory:

  • ATTACHED_LAYOUT_ID

  • BOX_ID

  • PAGE_NAME

  • PAGE_INDEX

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:

  • ARTICLE_ID

  • ARTICLE_COMPONENT_ID

Returns

Returns an assetRelationInfo object in XML format with an updated set of attributes. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/relations/[relation id]?op=update

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetRelationInfo relationStateId="3"
   relationState="Related Temporarily"
   relationTypeId="2"
   relationType="Secondary Attachment"
   childAssetMinorVersion="2"
   childAssetMajorVersion="0"
   childAssetName="1quark2.jpg"
   childAssetId="4"
   parentAssetName="15116.qxp"
   parentAssetId="5" id="13">
    <attributeValueList>
      <attributeValue type="numeric" name="Attached Layout Uid" id="401">1</attributeValue>
      <attributeValue type="numeric" name="Box Uid" id="402">5</attributeValue>
      <attributeValue type="text" name="Page Name" id="403">1</attributeValue>
      <attributeValue type="numeric" name="Page Index" id="404">1</attributeValue>
      <attributeValue type="numeric" name="Attached Component Id" id="412">1</attributeValue>
    </attributeValueList>
  </assetRelationInfo>

deleteAssetRelations

Function

Delete a relationship by its id.

Description

This request deletes a specific relationship between two assets.

Type

POST

URL Format

.../assets/relations/[relation ID]

Java API

Method Name

Class Name

deleteAssetRelations

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=delete

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:

http://serverName:serverPort/rest/service/assets/relations/[relation id]?op=delete

deleteAssetRelationsForParent

Function

Delete an asset's relationship.

Description

This request removes all child relations of a specified asset.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

deleteAssetRelationsForParent

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=deleterelations

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.

childassetid=[x]

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:

http://serverName:serverPort/rest/service/assets/27?op=deleterelations

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

.../assets/

Java API

Method Name

Class Name

generateTextIndexesOfAllAssets

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=generatetextindexes

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:

http://serverName:serverPort/rest/service/assets?op=generatetextindexes

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

.../assets/[asset id]?op=generatetextindexes...

Java API

Method Name

Class Name

generateTextIndexes

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=generatetextindexes

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

assetid=[asset Id]

long

The ID of the asset. (Mandatory)

Returns

A status of 200 is returned in response to a successful request execution.

Examples

URL:

http://serverName:serverPort/rest/service/assets/<assetId>?op=generatetextindexes

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAssetVersionNumbers

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=listversions

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

Returns

Returns an assetVersionList object containing an array of all versions of the same asset.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?op=listversions

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetVersionList>
    <assetVersion minorVersion="1" majorVersion="0"/>
    <assetVersion minorVersion="2" majorVersion="0"/>
  </assetVersionList>

getAssetRenditionsInfo

Function

Get information about an asset's renditions.

Description

This request returns all information about an asset's reditions.

Type

GET

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAssetRenditionsInfo

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=renditioninfo

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

rendition=preview or rendition=2

string

By specifying rendition type, metadata of that rendition will be returned. (Optional)

Available renditions are:

  • PREVIEW

  • THUMBNAIL

  • ARTICLE_PAGE_PICTURE

  • DECONSTRUCTED_XML

  • TEXT

majorversion=[x]and minorversion=[x]

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 assetRenditionInfoList object containing an array of all available renditions of the same asset.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?op=renditioninfo

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetRenditionInfoList>
    <assetRenditionInfo fileSize="80357" fileExtension="jpg" filePath="/00/04/4.0-2.2.1.jpg" repositoryId="1" pageNumber="1" layoutNumber="1" renditionTypeId="2" renditionType="PREVIEW" minorVersion="2" majorVersion="0" assetId="4"/>
    <assetRenditionInfo fileSize="47142" fileExtension="jpg" filePath="/00/04/4.0-2.3.1.jpg" repositoryId="1" pageNumber="1" layoutNumber="1" renditionTypeId="3" renditionType="THUMBNAIL" minorVersion="2" majorVersion="0" assetId="4"/>
  </assetRenditionInfoList>

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

getAvailableRenditions

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=listrenditiontypes

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

majorversion=[x]and minorversion=[x]

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 namedList object containg an array of all renditions for the specified asset.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?op=listrenditiontypes

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <nameIdList>
    <nameId id="2" name="PREVIEW"/>
    <nameId id="3" name="THUMBNAIL"/>
  </nameIdList>

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

.../assetsbypath/[parent asset path] or /assets/[parent asset ID]

Java API

Method Name

Class Name

updateChildVersionForAsset

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=updatechildversion

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.

childassetid=[asset ID]

long

The ID of the child asset. (Mandatory)

majorversion=[x] and minorversion=[x]

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:

http://serverName:serverPort/rest/service/assets/[parent asset id]?op=updatechildversion&childassetid=4

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

.../assets/relations/[relation ID]

Java API

Method Name

Class Name

updateChildAssetVersionForRelationId

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=updatechildversion

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.

majorversion=[x] and minorversion=[x]

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:

http://serverName:serverPort/rest/service/assets/relations/[relation id]?op=updatechildversion

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

.../assetsbypath/[parent asset path] or /assets/[parent asset ID]

Java API

Method Name

Class Name

updateAllChildAssetsVersion

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=updateallchildversion

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

relationtype=[x]

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:

http://serverName:serverPort/rest/service/assets/[parent asset id]?op=updateallchildversion

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

op=updatelockflag

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

flag=[true or false]

boolean

True for locked, false for unlocked. (Mandatory)

Returns

A status of 200 is returned in response to a successful request execution.

Examples

URL:

http://serverName:serverPort/rest/service/assets/relations/19?op=updatelockflag&flag=true

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

checkIn

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=checkin

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.

attributevalues=<xml/>

 

See "Request/Response parameter formats."

List of attribute values which need to be updated.

 

relations=<xml/>

 

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:

  • ATTACHED_LAYOUT_ID

  • BOX_ID

  • PAGE_NAME

  • PAGE_INDEX

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:

  • ARTICLE_ID

  • ARTICLE_COMPONENT_ID

createminorversion =[true | false]

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:

http://serverName:serverPort/rest/service/assets/4?op=checkin&attributevalues=

 <attributeValueList >
    <attributeValue id="2">1quark2.jpg</attributeValue>
    <attributeValue id="54">10</attributeValue>
    <attributeValue id="55">1</attributeValue>
    <attributeValue id="24">10</attributeValue>
    <attributeValue id="11">jpg</attributeValue>
    <attributeValue id="33">1quark2.jpg</attributeValue>
    <attributeValue id="25">admin</attributeValue>
  </attributeValueList>
  <assetInfo id="4">
    <assetVersion minorVersion="1" majorVersion="0"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">4</attributeValue>
      <attributeValue type="text" name="Name" id="2">1quark2.jpg</attributeValue>
      ....
    </attributeValueList>
  </assetInfo>

Result:

The assetInfo object of the latest version of the asset to be checked into the QPP server.

checkInNew

Function

Check in a new asset.

Description

Include the file in the request body or as file part.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[New Asset Name]

Java API

Method Name

Class Name

checkInNew

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=checkinnew

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

attributevalues=<xml/>

 

See "Request/Response parameter formats."

<attributeValueList>
  <attributeValue id="62"> 1103 </attributeValue>
  <attributeValue id="54"> 10 </attributeValue>
  <attributeValue id="24"> 10 </attributeValue>
  <attributeValue id="11"> jpg </attributeValue>
  <attributeValue id="33"> Original file </attributeValue>
  <attributeValue id="25"> 1 </attributeValue>
</attributeValueList>

The following attributes are Mandatory:

  • Content type (There is a choice between content type ID, Name and Hierarchy when providing a value for the Content type attribute.)

  • Collection (There is a choice between collection ID, Name and Path when providing a value for the Collection attribute).

  • Workflow

  • Status

  • File extension

  • Original filename

relations=<xml/>

 

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).

createminorversion =[true | false]

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 assetInfo object of the newly checked in asset with its metadata.

Examples

URL: 

http://serverName:serverPort/rest/service/assetsbypath/Home/Tulips?attributevalues=

  <attributeValueList>
    <attributeValue id="62">System;Asset;Picture;</attributeValue>
    <attributeValue id="54">10</attributeValue>
    <attributeValue id="24">10</attributeValue>
    <attributeValue id="11">jpg</attributeValue>
    <attributeValue id="33">Original file</attributeValue>
    <attributeValue id="25">1</attributeValue>
  </attributeValueList>
&op=checkinnew

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="10">
    <assetVersion minorVersion="0" majorVersion="1"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">10</attributeValue>
      <attributeValue type="text" name="Name" id="2">Tulips</attributeValue>
      <attributeValue type="dateTime" name="Created" id="3">2013-04-11T05:12:51Z</attributeValue>
      <attributeValue type="dateTime" name="Last modified" id="4">2013-04-11T05:12:51Z</attributeValue>
      <attributeValue type="popup" name="Creator" id="5">Admin</attributeValue>
      <attributeValue type="popup" name="Last modifier" id="6">Admin</attributeValue>
      <attributeValue type="numeric" name="Major version" id="7">1</attributeValue>
      <attributeValue type="text" name="File path" id="8">/00/0a/10.1-0.1.1.jpg</attributeValue>
      <attributeValue type="text" name="File extension" id="11">jpg</attributeValue>
      <attributeValue type="numeric" name="File size" id="12">115191</attributeValue>
      <attributeValue type="boolean" name="Is checked out" id="13">false</attributeValue>
      <attributeValue type="dateTime" name="Last content update" id="19">2013-04-11T05:12:51Z</attributeValue>
      <attributeValue type="popup" name="Last content updated by" id="20">Admin</attributeValue>
      <attributeValue type="popup" name="Routed to" id="25">Admin</attributeValue>
      <attributeValue type="popup" name="Status" id="24">Status1</attributeValue>
      <attributeValue type="popup" name="Repository type" id="27">fileRepositoryAdapter</attributeValue>
      <attributeValue type="popup" name="Indexing status" id="29">Pending</attributeValue>
      <attributeValue type="popup" name="Repository" id="28">QPS_Repo</attributeValue>
      <attributeValue type="boolean" name="Is placeholder" id="30">false</attributeValue>
      <attributeValue type="popup" name="Content creator" id="32">Admin</attributeValue>
      <attributeValue type="text" name="Original filename" id="33">Original file</attributeValue>
      <attributeValue type="popup" name="Collection" id="55">Home</attributeValue>
      <attributeValue type="popup" name="Workflow" id="54">Workflow1</attributeValue>
      <attributeValue type="popup" name="Content Type" id="62">Picture</attributeValue>
      <attributeValue type="numeric" name="Minor version" id="61">0</attributeValue>
      <attributeValue type="boolean" name="Has Children" id="65">false</attributeValue>
      <attributeValue type="text" name="Collection Path" id="57">Home</attributeValue>
      <attributeValue type="text" name="Content Type Hierarchy" id="63">System;Asset;Picture</attributeValue>
    </attributeValueList>
  </assetInfo>

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

.../assetsbypath/[asset path] or /assets/[asset name]

Java API

Method Name

Class Name

checkInArticle

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=checkinarticle

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.

attributevalues=<xml/>

 

See "Request/Response parameter formats."

List of attribute values which need to be updated.

 

relations=<xml/>

 

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)

createminorversion =[true | false]

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:

http://serverName:serverPort/rest/service/assetsbypath/Home/15116d12.qcd?op=checkin&attributevalues=

  <attributeValueList>
    <attributeValue id="2">15348a77.qcd</attributeValue>
    <attributeValue id="54">Workflow1</attributeValue>
    <attributeValue id="55">Home</attributeValue>
    <attributeValue id="24">Status1</attributeValue>
    <attributeValue id="11">qcd</attributeValue>
    <attributeValue id="33">15348a77.qcd</attributeValue>
    <attributeValue id="25">1</attributeValue>
  </attributeValueList>
& components=
  <articleComponentInfoList>
    <articleComponentInfo componentId="15">
      <attributeValueList>
        <attributeValue name="Component Name">Component 1</attributeValue>
       <attributeValue name="Content Type">1250</attributeValue>
        <attributeValue name="Article Component Id">1</attributeValue>
      </attributeValueList>
    </articleComponentInfo>
    <articleComponentInfo componentId="14">
      <attributeValueList>
        <attributeValue name="Component Name">Component2</attributeValue>
        <attributeValue name="Content Type">1300</attributeValue>
        <attributeValue name="Article Component Id">2</attributeValue>
        </attributeValueList>
    </articleComponentInfo>
  </articleComponentInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="53">
    <assetVersion minorVersion="0" majorVersion="1"/>
    <attributeValueList>
      <attributeValue valueId="0" type="numeric" name="Id" id="1">53</attributeValue>
      <attributeValue valueId="0" type="text" name="Name" id="2">15116d12.qcd</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Created" id="3">2014-04-09T09:51:45Z</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2014-04-09T09:51:45Z</attributeValue>
      <attributeValue valueId="1" type="popup" name="Creator" id="5">Admin</attributeValue>
      <attributeValue valueId="1" type="popup" name="Last modifier" id="6">Admin</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Major version" id="7">1</attributeValue>
      <attributeValue valueId="0" type="text" name="File path" id="8">/00/35/53.1-0.1.1.qcd</attributeValue>
      <attributeValue valueId="0" type="text" name="File extension" id="11">qcd</attributeValue>
      <attributeValue valueId="0" type="numeric" name="File size" id="12">284672</attributeValue>
      <attributeValue valueId="0" type="boolean" name="Is checked out" id="13">false</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Last content update" id="19">2014-04-09T09:51:45Z</attributeValue>
      <attributeValue valueId="1" type="popup" name="Last content updated by" id="20">Admin</attributeValue>
      <attributeValue valueId="1" type="popup" name="Routed to" id="25">Admin</attributeValue>
      <attributeValue valueId="10" type="popup" name="Status" id="24">Status1</attributeValue>
      <attributeValue valueId="1" type="popup" name="Repository type" id="27">fileRepositoryAdapter</attributeValue>
    </attributeValueList>
  </assetInfo>

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

.../assetsbypath/[asset path] or /assets/[asset name]

Java API

Method Name

Class Name

checkInNewArticle

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=checkinnewarticle

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

attributevalues=<xml/>

 

See "Request/Response parameter formats."

<attributeValueList>
    <attributeValue id="62"> 1103 </attributeValue>
    <attributeValue id="54"> 10 </attributeValue>
    <attributeValue id="24"> 10 </attributeValue>
    <attributeValue id="11"> jpg </attributeValue>
    <attributeValue id="33"> Original file </attributeValue>
    <attributeValue id="25"> 1 </attributeValue>
</attributeValueList>

The following attributes are Mandatory:

  • Content type (There is a choice between content type ID, Name and Hierarchy when providing a value for the Content type attribute.)

  • Collection (There is a choice between collection ID, Name and Path when providing a value for the Collection attribute)

  • Workflow

  • Status

  • File extension

  • Original filename

relations=<xml/>

 

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).

createminorversion =[true | false]

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 assetInfo object of the newly checked in asset with its metadata.

Examples

URL:

http://serverName:serverPort/rest/service/assets/15116d12.qcd?op=checkinnew&attributevalues=

<?xml version="1.0" encoding="UTF-8"?>
  <attributeValueList>
    <attributeValue id="62">11011</attributeValue>
    <attributeValue name="workflow">Workflow1</attributeValue>
    <attributeValue name="collection">1</attributeValue>
    <attributeValue id="24">10</attributeValue>
    <attributeValue id="11">qcd</attributeValue>
    <attributeValue id="33">15348.qcd</attributeValue>
    <attributeValue name="routed to">1</attributeValue>
  </attributeValueList>
&createminorversion=false&components=
  <articleComponentInfoList>
    <articleComponentInfo>
      <attributeValueList>
        <attributeValue name="Component Name">Component1</attributeValue>
        <attributeValue name="Content Type">1250</attributeValue>
        <attributeValue name="Article Component Id">1</attributeValue>
      </attributeValueList>
    </articleComponentInfo>
    <articleComponentInfo>
       <attributeValueList>
        <attributeValue name="Component Name">Component 2</attributeValue>
        <attributeValue name="Content Type">1300</attributeValue>
        <attributeValue name="Article Component Id">2</attributeValue>
      </attributeValueList>
    </articleComponentInfo>
  </articleComponentInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="53">
    <assetVersion minorVersion="0"majorVersion="1"/>
    <attributeValueList>
      <attributeValue valueId="0" type="numeric" name="Id" id="1">53</attributeValue>
      <attributeValue valueId="0" type="text" name="Name" id="2">15116d12.qcd</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Created" id="3">2014-04-09T09:51:45Z</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2014-04-09T09:51:45Z</attributeValue>
      <attributeValue valueId="1" type="popup" name="Creator" id="5">Admin</attributeValue>
      <attributeValue valueId="1" type="popup" name="Last modifier" id="6">Admin</attributeValue>
      <attributeValue valueId="0" type="numeric" name="Major version" id="7">1</attributeValue>
      <attributeValue valueId="0" type="text" name="File path" id="8">/00/35/53.1-0.1.1.qcd</attributeValue>
      <attributeValue valueId="0" type="text" name="File extension" id="11">qcd</attributeValue>
      <attributeValue valueId="0" type="numeric" name="File size" id="12">284672</attributeValue>
      <attributeValue valueId="0" type="boolean" name="Is checked out" id="13">false</attributeValue>
      <attributeValue valueId="0" type="dateTime" name="Last content update" id="19">2014-04-09T09:51:45Z</attributeValue>
      <attributeValue valueId="1" type="popup" name="Last content updated by" id="20">Admin</attributeValue>
      <attributeValue valueId="1" type="popup" name="Routed to" id="25">Admin</attributeValue>
      <attributeValue valueId="10" type="popup" name="Status" id="24">Status1</attributeValue>
      <attributeValue valueId="1" type="popup" name="Repository type" id="27">fileRepositoryAdapter</attributeValue>
    </attributeValueList>
  </assetInfo>

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

.../assetsbypath/[asset path] or /assets/[assetId]

Java API

Method Name

Class Name

checkInRendition

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=checkinrendition

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

rendition=highres or rendition=1

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

fileext=[file extension]

string

The file extension of the rendition files being checked in. (Mandatory)

pages=[pages]

long

The number of pages contained in the rendition being created. (Optional)

majorversion=[x] and minorversion=[x]

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:

http://serverName:serverPort/rest/service/assets/4?rendition=preview&fileext=jpg& majorversion=0&minorversion=2&op=checkinrendition

checkOut

Function

Check out an asset

Description

This request checks out the specified asset and returns its stream.

Type

POST

URL Format

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

checkOut

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=checkout

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

attributevalues=<xml/>

string in XML format

See "Request/Response parameter formats."

<attributeValueList>
    <attributeValue id="16"> E:\REST\QPP Rest\TestData\CheckoutFilePath </attributeValue>
    <attributeValue id="34"> REST _CLIENT </attributeValue>
</attributeValueList>

The following attributes are Mandatory:

  • CHECKOUT_FILE_PATH

  • CHECKOUT_APPLICATION

Returns

Returns an asset stream after marking it checked out.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?attributevalues=

  <attributeValueList>
    <attributeValue id="16">E:\REST\QPP Rest\TestData\CheckoutFilePath</attributeValue>
    <attributeValue id="34">REST _CLIENT</attributeValue>
  </attributeValueList>
&op=checkout

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

.../assetsbypath/[asset path] or /assets/[asset ID]

Java API

Method Name

Class Name

abortCheckout

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=abortcheckout

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 assetInfo object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/assets/4?op=abortcheckout

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="4">
    <assetVersion minorVersion="2" majorVersion="0"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id"id="1">4</attributeValue>
      <attributeValue type="text" name="Name"id="2">1quark2.jpg</attributeValue>
      <attributeValue type="dateTime" name="Created" id="3">2013-04-10T09:37:56Z</attributeValue>
      .....
    </attributeValueList>
  </assetInfo>

Result:

The assetInfo object in XML format.

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

/assets/[asset ID]

Java API

Method Name

Class Name

saveDraft

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=savedraft

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:

http://serverName:serverPort/rest/service/assets/{asset Id}?op=savedraft

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

/assets/[asset ID]

Java API

Method Name

Class Name

promoteDraft

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=promotedraft

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

attributes= [comma-separated list of attribute names or IDs]

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)

Createminorversion={true|false}

string

By default value is false.

Returns

Returns an assetInfo object along with a list of attribute values for this new asset version.

Examples

URL:

http://serverName:serverPort/rest/service/assets/{asset Id}?op=promotedraft

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <assetInfo id="40">
    <assetVersion minorVersion="0" majorVersion="3"/>
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">40</attributeValue>
      <attributeValue type="text" name="Name" id="2">abc.xlsx</attributeValue>
      <attributeValue type="dateTime" name="Created" id="3">2014-08-18T07:23:30Z</attributeValue>
      ....
    <attributeValueList/>
  </assetInfo>

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

.../assets

Java API

Method Name

Class Name

detectContentType

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

fileextension

string

The file extension of the asset.

mimetype

string

The mime type of the asset.

Returns

 

Examples

URL:

http://serverName:serverPort/rest/service/assets?op=detectcontenttype

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <contentTypeInfo id="11011">
    <name>QuarkCopyDesk Article</name>
    <contentTypeHierarchy>System;Asset;Document;QuarkCopyDesk Article;</contentTypeHierarchy>
    <systemDefined>true</systemDefined>
    <childrenAvailable>false</childrenAvailable>
    <extensible>true</extensible>
  </contentTypeInfo>

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

/assets/[asset ID]

Java API

Method Name

Class Name

reIndex

com.quark.qpp.service.facade Class AssetFacade

Parameters

Name

Type

Description

op=reindex

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:

http://serverName:serverPort/rest/service/assets/{asset Id}?op=reindex

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

/assetsbypath/{collectionPath}/[AssetName]

Java API

Method Name

Class Name

reIndex

com.quark.qpp.service.facade Class AssetsByPathFacade

Parameters

Name

Type

Description

op=reindex

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:

http://serverName:serverPort/rest/service/assetsbypath/{Collection Hierarchy}/{AssetName}?op=reindex