Rest Interface Guide

Collection management

The collection management capabilities of the API allow application developers to manage collections and includes the following REST calls:

createCollection

Function

Create a collection.

Description

This request creates a new collection according to the given attributes.

Type

POST

URL Format

.../collections/[collection name] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

createCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=create

string

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

targetparent=[collection path or ID]

long or string

The parent collection for the new collection. (Mandatory)

There is a choice between collection ID, Name and Path when providing a value.

attributevalues=<xml/>

string

The set of attribute values.

See "Request/Response parameter formats."(All atributes are Optional)

contenttype=[content type name]

string

Defaults to GENERAL.

The default content type IDs are documented in the JavaDoc SDK at com.quark.qpp.core.content. service.constants.DefaultContentTypes.

To get a list of content types, use a call to ../admin/contenttypes.(Optional)

There is a choice between content type ID, Name and Hierarchy when providing a value.

Returns

Returns the collectionInfo object of the newly created collection.

Examples

URL:

http://serverName:serverPort/rest/service/collections/newChildCollection? op=create&targetparent=Home/childCollection

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <collectionInfo templateId="0"
   collectionClass="General"
   collectionClassId="1416"
   collectionTemplate="false"
   accessibleChildrenAvailable="true"
   domainId="19"
   name="newChildCollection"
   id="15">
    <attributeValueList>
      <attributeValue type="numeric"
       name="Id"
       id="1">1</attributeValue>
      ...
    </attributeValueList>
    <workflowInfoList>
      <workflowInfo id="10">
      <name>Workflow1</name>
      ...
        <statusInfoList>
          <statusInfo id="10">
          <name>Status1</name>
          ...
        </statusInfo>
      </statusInfoList>
    </workflowInfo>
    ....
    ....
  </collectionInfo>

Function

Create a collection template.

Description

This request creates a new collection template under the given parent collection.

Type

POST

URL Format

.../collections/[collection name] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

createCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=create

string

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

istemplate=[true|false]

boolean

Defaults to false. (Mandatory)

targetparent=[collection path or ID]

long or string

The parent collection for the new collection. (Mandatory)

attributevalues=<xml/>

string

The set of attribute values.

See "RequestResponse parameter formats."

All attributes are Optional.

contenttype=[content type name]

string

Defaults to GENERAL. The default content type IDs are documented in the JavaDoc SDK at com.quark.qpp.core.content. service.constants.DefaultContentTypes.

To get a list of content types, use a call to ../admin/contenttypes.(Optional)

Returns

Returns the collectionInfo object of the newly created collection template.

Examples

URL:

http://serverName:serverPort/rest/service/collections/newChildCollection? op=create&targetparent=Home/childCollection&istemplate=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <collectionInfo templateId="0"
   collectionClass="General"
   collectionClassId="1416"
   collectionTemplate="false"
   accessibleChildrenAvailable="true"
   domainId="19"
   name="newChildCollection"
   id="15">
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">1</attributeValue>
      ...
    </attributeValueList>
    <workflowInfoList>
      <workflowInfo id="10">
      <name>Workflow1</name>
      ...
      <statusInfoList>
        <statusInfo id="10">
        <name>Status1</name>
        ...
        </statusInfo>
      </statusInfoList>
    </workflowInfo>
    ....
    ....
  </collectionInfo>

createCollections

Function

Create multiple collections.

Description

This request creates multiple collections in a single request.

Type

POST

URL Format

.../collections

Java API

Method Name

Class Name

createCollections

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=create

string

The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id.

collectioninfolist=<xml/>

 

See "Request/Response parameter formats."

Returns

Returns a collectioninfolist object in XML format that contains the metadata of all successfully created collections.

Examples

URL:

https://serverName:serverPort/rest/service/collections?op=create&collectioninfolist=

<?xml version="1.0" encoding="UTF-8"?>
  <collectionInfoList>
    <collectionInfo collectionClassId="1416"
     collectionTemplate="false"
     collectionPath="Home/Home3" >
      <attributeValueList>
        <attributeValue valueId="0" type="text" name="Name" id="2">Home3</attributeValue>
        <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
        <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2010-04-01T10:00:00Z</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="boolean" name="Is Template" id="59">false</attributeValue>
        <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home/Home1</attributeValue>
        <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
        <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
      </attributeValueList>
    </collectionInfo>
  </collectionInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <collectionInfoList>
    <collectionInfo
     defaultJobJacketTicket="Default Job Ticket"
     defaultJobJacketName="Default Job Jacket"
     defaultJobJacketId ="1"
     templateId="0"
     collectionClass="General"
     collectionClassId="1416"
     collectionTemplate="false"
     accessibleChildrenAvailable="false"
     domainId="19"
     collectionPath="Home/Home3"
     name="Home3"
     id="23">
      <attributeValueList>
        <attributeValue valueId="0" type="numeric" name="Id" id="1">23</attributeValue>
        <attributeValue valueId="0" type="text" name="Name" id="2">Home3</attributeValue>
        <attributeValue valueId="0" type="dateTime" name="Created" id="3">2014-04-10T06:09:46Z</ attributeValue >
        ....
      </attributeValueList>
    <workflowInfoList/>
  <routingInfoList/>
  <userInfoList>
    <userInfo id="1">
     <name>Admin</name >
      .....
    </userInfo>
  </userInfoList>
<groupInfoList/>
  <jobJacketInfoList>
    <jobJacketInfo id="1">
      <name>Default Job Jacket</name>
      .....
    </jobJacketInfo>
  </jobJacketInfoList>
</collectionInfoList>
</collectionInfo>
</collectionInfoList>

getCollection

Function

Get all of a collection's metadata.

Description

This request returns all of the metadata associated with an entire collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

This request requires no input parameters.

Returns

Returns a collectionInfo object with all its metadata and a list of its attributes.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <collectionInfoList>
    <collectionInfo
     defaultJobJacketTicket="Default Job Ticket"
     defaultJobJacketName="Default Job Jacket"
     defaultJobJacketId="1"
     templateId="0"
     collectionClass="General"
     collectionClassId="1416"
     collectionTemplate="false"
     accessibleChildrenAvailable="true"
     domainId="19"
     collectionPath="Home"
     name="Home"
     id="1">
      <attributeValueList>
        <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
        <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
        <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
        <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
        <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
        <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
        <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
      </attributeValueList>
    </collectionInfo>
  </collectionInfoList>

Function

Get specific collection attributes.

Description

This request returns all of the attrubutes associated with a specific collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

attributes=[attribute name or ID], [attribute name or ID],...

string

To get a list of all attribute IDs, use a call to../admin/attributes. (Mandatory)

Returns

Returns a collentionInfo object with the specified attributes.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?attributes=1,name,creator

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <collectionInfo id="1">
    <attributeValueList>
      <attributeValue type="numeric" name="Id" id="1">1</attributeValue>
      <attributeValue type="text" name="Name" id="2">Home</attributeValue>
      <attributeValue type="popup" name="Creator" id="5">Admin</attributeValue>
    </attributeValueList>
  </collectionInfo>

Function

Get a collection's workflows.

Description

This request returns all of the workflows associated with a collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

workflows=[true|false]

boolean

Defaults to false. (Mandatory)

Returns

Returns a collectionInfo object with the metadata of the workflows only.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?workflows=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
      templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home"
      id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <workflowInfoList>
         <workflowInfo id="10">
         <name>Workflow1</name>
         <domainId>18</domainId>
         .......
           <statusInfoList>
             <statusInfo id="10">
               <name>Status1</name>
               <domainId>6</domainId>
               ........
             </statusInfo>
           </statusInfoList>
           <contentTypeInfoList>
             <contentTypeInfo id="1100">
               ......
             </contentTypeInfo>
             <contentTypeInfo id="1101">
               ......
             </contentTypeInfo>
           </contentTypeInfoList>
         </workflowInfo>
       </workflowInfoList>
     </collectionInfo>
   </collectionInfoList>

Function

Get a collection's workflow for a specific content type.

Description

This request returns all of the workflows associated with a specific content type.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

workflows=[true|false]

boolean

Defaults to false. (Mandatory)

contenttypes=[content type ID] or [content type name]

long

The default content type IDs are documented in the JavaDoc SDK at com.quark.qpp.core. content.service.constants.DefaultContentTypes. To get a list of content types, use a call to ../admin/contenttypes.(Optional) If not provided, the metadata of all workflows will be returned.

Returns

Returns a collectionInfo object with the metadata of the workflows associated with the specified content type.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1 ?workflows=true&contenttype=Picture

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
     templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home"
      id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <workflowInfoList>
         <workflowInfo id="10">
           <name>Workflow1</name>
           <domainId>18</domainId>
           .......
           <statusInfoList>
             <statusInfo id="10">
               <name>Status1</name>
               <domainId>6</domainId>
               ........
             </statusInfo>
           </statusInfoList>
           <contentTypeInfoList>
             <contentTypeInfo id="1103">
               ......
             </contentTypeInfo>
           </contentTypeInfoList>
         </workflowInfo>
       </workflowInfoList>
     </collectionInfo>
   </collectionInfoList>

Function

Get a collection's users.

Description

This request returns a list of the users of a collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

users=[true|false]

boolean

Defaults to false. (Mandatory)

Returns

Returns a collectionInfo object with the metadata of users only.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?users=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
      templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home"
      id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <userInfoList>
         <userInfo id="1">
           <name>Admin</name>
           <firstName>Administrator</firstName>
           <nativeTrustee>trie</nativeTrustee>
           <enabled>true</enabled>
           <defaultUserClassid>1</defaultUserClassid>
           <IdapProfileId>0</firstIdapProfileIdtName>
           <deleted>false</deleted>
           <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
         </userInfo>
           .......
       </userInfoList>
     </collectionInfo>
   </collectionInfoList>

Function

Get a collection's groups.

Description

This request returns a list of the groups associated with a collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

groups=[true|false]

boolean

Defaults to false. (Mandatory)

Returns

Returns a collectionInfo object with the metadata of groups only.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?groups=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
      templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home"
      id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <groupInfoList>
         <groupInfo id="12">
           <name>Group1</name>
           <emailAddress>Editors@company.com</emailAddress>
           <nativeTrustee>false</nativeTrustee>
           <defaultUserClassId>2</defaultUserClassId>
           <defaultUserClass>NoPrivileges</defaultUserClass>
           <ldapProfileId>10</ldapProfileId>
           <ldapProfile>Profile Name</ldapProfile>
           <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
           <memberList>
           <nameId id="1">
           <name>Admin</name>
         </nameId>
           ........
         </memberList>
       </userInfoList>
    </collectionInfo>
   </collectionInfoList>

Function

Get the routings for a collection's workflow.

Description

This request returns all of the routings for a collection's workflow.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

routings=[true|false]

boolean

Defaults to false. (Mandatory)

workflow=[workflow name]

long or string

Specify the workflow name or ID. (Mandatory)

Returns

Returns a collectionInfo object with the metadata of the routings of the specified workflow.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?routings=true&workflow=Workflow1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
      templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home"
      id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <routingInfoList>
         <routingInfo>
           <trusteeId>1</trusteeId>
           <trustee>Admin</trustee>
           <routingTypeId>1</routingTypeId>
           <routingType>User</routingType>
           <workflowId>10</workflowId>
           <workflow>Workflow1</workflow>
           <statusId>10</statusId>
           <status>Status1</status>
         </routingInfo>
           .....
       </routingInfoList>
     </collectionInfo>
   </collectionInfoList>

Function

Get a collection's revision controls.

Description

This request returns all of the revision controls for a collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

revisioncontrols=[true|false]

boolean

Defaults to false. (Mandatory)

Returns

Returns a collectionInfo object with metadata of the revision controls settings.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?revisioncontrols=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
      templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home"
      id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <revisionControlInfoList>
         <revisionControlInfo contentType="Asset" contentTypeId="1100">
           <minorVersioningAllowed>true</minorVersioningAllowed>
           <allRevisions>true</allRevisions>
           <initialRevisionsCount>0</initialRevisionsCount>
         <recentRevisionsByPeriod>false</recentRevisionsByPeriod>
           <recentRevisionsCount>0</recentRevisionsCount>
           <recentRevisionsDuration>0</recentRevisionsDuration>
         </revisionControlInfo>
           .....
       </revisionControlInfoList>
     </collectionInfo>
   </collectionInfoList>

Function

Get a collection's Job Jackets files.

Description

This request returns all of the job jackets for a collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

jobjackets=[true|false]

boolean

Defaults to false. (Mandatory)

Returns

Returns a collectionInfo object with the metadata of associated job jackets.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?jobjackets=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <collectionInfoList>
    <collectionInfo
     defaultJobJacketTicket="Default Job Ticket"
     defaultJobJacketName="Default Job Jacket"
     defaultJobJacketId="1"
     templateId="0"
     collectionClass="General"
     collectionClassId="1416"
     collectionTemplate="false"
     accessibleChildrenAvailable="true"
     domainId="19"
     collectionPath="Home"
     name="Home"
     id="1">
      <attributeValueList>
        <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
        <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
        <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
       <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
        <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
        <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
        <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
      </attributeValueList>
      <jobJacketInfoList>
        <jobJacketInfo id="1">
          <name>Default Job Jacket</name>
          <domainId>0</domainId>
          <defaultTicketTemplate>Default Job Ticket</defaultTicketTemplate>
          ......
          <ticketTemplateList>
            <ticketTemplate>Default Job Ticket</ticketTemplate>
          </ticketTemplateList>
          <content>
             ......
          </content>
        </jobJacketInfo>
      </jobJacketInfoList>
    </collectionInfo>
  </collectionInfoList>

Function

Get a collection's child collections.

Description

This request returns immediate child collections accessible to the logged on user.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

childcollections =[true|false]

boolean

Defaults to false. (Mandatory)

Returns

Returns a collectionInfo object with the list of child collections that is accessible to the logged-in user.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?childcollections=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
      templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home"
      id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1"></attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <collectionInfoList>
         <collectionInfo
          defaultJobJacketTicket="Default Job Ticket"
          defaultJobJacketName="Default Job Jacket"
          defaultJobJacketId="1"
          templateId="0"
          collectionClass="General"
          collectionClassId="1416"
          collectionTemplate="false"
          accessibleChildrenAvailable="true"
          domainId="19"
          collectionPath="Home/Collection"
          name="Collection"
          id="10">
           <attributeValueList>
             <attributeValue valueId="0" type="numeric" name="Id" id="1">10</attributeValue>
             .....
           </attributeValueList>
         </collectionInfo>
         <collectionInfo
          templateId="0"
          collectionClass="General"
          collectionClassId="1416"
          collectionTemplate="false"
          accessibleChildrenAvailable="false"
          domainId="19"
          collectionPath="Home/Collection_84546"
          name="Collection_84546"
          id="13">
           <attributeValueList>
             <attributeValue valueId="0" type="numeric" name="Id" id="1">13</attributeValue>
             ......
           </attributeValueList>
         </collectionInfo>
       </collectionInfoList>
     </collectionInfo>
   </collectionInfoList>

Function

Get a collection's parent collection.

Description

This request returns all of the accessible parent collections for a collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

parentcollections =[true|false]

boolean

Defaults to false. (Mandatory)

Returns

Returns a collectionInfo object of ancestor collections up the hierarchy based on access control. While going up the hierarchy, if there exists any inaccessible collection (for which the logged on user does not have access to), the collection path array will contain collectionInfo objects of only those collections which are lying below that collection.

Examples

URL:

http://serverName:serverPort/rest/service/collections/10?parentcollections=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo
      defaultJobJacketTicket="Default Job Ticket"
      defaultJobJacketName="Default Job Jacket"
      defaultJobJacketId="1"
      templateId="0"
      collectionClass="General"
      collectionClassId="1416"
      collectionTemplate="false"
      accessibleChildrenAvailable="true"
      domainId="19"
      collectionPath="Home"
      name="Home" id="1">
       <attributeValueList>
         <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
         <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
         <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2013-12-23T12:07:27Z</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="boolean" name="Is Template" id="59">false</attributeValue>
         <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home</attributeValue>
         <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
         <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
       </attributeValueList>
       <parentColInfoList>
         <collectionInfo
          defaultJobJacketTicket="Default Job Ticket"
          defaultJobJacketName="Default Job Jacket"
          defaultJobJacketId="1"
          templateId="0"
          collectionClass="General"
          collectionClassId="1416"
          collectionTemplate="false"
          accessibleChildrenAvailable="true"
          domainId="0"
          collectionPath="Home"
          name="Home"
          id="1">
           <attributeValueList>
             <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
             <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue>
             .....
           </attributeValueList>
         </collectionInfo>
       </parentColInfoList>
     </collectionInfo>
   </collectionInfoList>

Function

Get collection assets and specify asset display attributes.

Description

This request returns collection assets by considering asset display attributes.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

assets=[true]

boolean

(Mandatory)

assetattributes

long or string

An array of display attributes IDs or names to be used while querying for assets within a collection.

Returns

Returns a collectionInfoList object containing a list of collections assets.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?assets=true&assetattributes=Name,collection

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <collectionInfoList>
    <collectionInfo
     id="1"
     name="Home"
     collectionPath="Home"
     domainId="19"
     accessibleChildrenAvailable="true"
     collectionTemplate="false"
     collectionClassId="1416"
     collectionClass="General"
     templateId="0"
     defaultJobJacketId="1"
     defaultJobJacketName="Default Job Jacket"
     defaultJobJacketTicket="Default Job Ticket">
      <attributeValueList>
         <attributeValue id="1" name="Id" type="numeric">1</attributeValue>
          .................
      </attributeValueList>
      <assetInfoList>
        <assetInfo id="10">
          <attributeValueList>
            <attributeValue id="2" name="Name" type="text"> Workflows.json.txt </attributeValue>
            <attributeValue id="55" name="Collection" type="popup" valueId="1" multiValued="false"> Home </attributeValue>
          </attributeValueList>
        </assetInfo>
        <assetInfo id="11">
          <attributeValueList>
            <attributeValue id="2" name="Name" type="text"> Workflows.json.txt </attributeValue>
            <attributeValue id="55" name="Collection" type="popup" valueId="1" multiValued="false"> Home </attributeValue>
          </attributeValueList>
        </assetInfo>
       </assetInfoList>
    </collectionInfo>
  </collectionInfoList

Function

Get all collections in the hierarchy of the given collection along with assets and specific asset display attributes.

Description

This request returns a complete collection hierarchy of the given collection alon with collection assets with specific asset display attributes.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

hierarchy=[true]

boolean

(Mandatory)

assets=[true]

boolean

(Mandatory)

assetattributes

long or string

An array of display attributes IDs or names to be used while querying for assets within a collection.

Returns

Returns a collectionInfoList object containing all collections in the hierarchy of a given collection along with assets specific metadata as specified in the assetattributes parameter.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?hierarchy=true& assets=true&assetattributes=Name,collection

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <collectionInfoList>
     <collectionInfo id="1" name="Home" collectionPath="Home">
       <assetInfoList>
         <assetInfo id="10">
         .................
       </assetInfoList>
       <collectionInfoList>
         <collectionInfo id="10" name="Demo"            collectionPath="Home/Demo>
             <assetInfoList>
               <assetInfo id="1">
                 <attributeValueList>
                   <attributeValue id="2" name="Name" type="text">Hydrangeas.PNG </attributeValue>
                   <attributeValue id="55" name="Collection" type="popup" valueId+'10" multivalued="false">Demo</attributeValue>
                 </attributeValueList>
               </assetInfo>
                 <assetInfo id="3">
                 ..................
               </assetInfoList>
             </collectionInfo>
           </collectionInfoList>
         </collectionInfo>

getCollectionHierarchy

Function

Get the metadata of each collection in the hierarchy.

Description

This request returns all of the metadata associated with each collection in the hierarchy

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollectionHierarchy

com.quark.qpp.service.facade Class CollectionFacade

ParametersReturns

Name

Type

Description

hierarchy=[true|false]

boolean

Defaults to true. (Mandatory)

attributes=[attribute name or ID], [attribute name or ID],...

string

To get a list of all attribute IDs, use a call to ../admin/attributes. (Optional)

workflows=[true|false]

boolean

Defaults to false. (Optional)

users=[true|false]

boolean

Defaults to false. (Optional)

groups=[true|false]

boolean

Defaults to false. (Optional)

routings=[true|false]

boolean

Defaults to false. (Optional)

revisioncontrols=[true|false]

boolean

Defaults to false. (Optional)

jobjackets=[true|false]

boolean

Defaults to false. (Optional)

contenttypes=[content type ID] or [content type name]

string

The default content type IDs are documented in the JavaDoc SDK at com.quark.qpp.core. content.service.constants.DefaultContentTypes. To get a list of content types, use a call to ../admin/contenttypes.(Optional)

This parameter can be concatenated with above mentioned parameters workflows and revision controls.

Returns a collectionInfoList object with the metadata of each collection in the hierarchy.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?hierarchy=true

Result:

<?xml version="1.0" encoding="UTF-8"?>
<collectionInfoList>
    <collectionInfo defaultJobJacketTicket="Default Job Ticket" defaultJobJacketName="Default Job Jacket" defaultJobJacketId="1" templateId="0" collectionClass="General" collectionClassId="1416" collectionTemplate="false" accessibleChildrenAvailable="true" domainId="19" collectionPath="Home" name="Home" id="1">
        <attributeValueList>
            <attributeValue valueId="0" type="numeric" name="Id" id="1">1</attributeValue>
            <attributeValue valueId="0" type="text" name="Name" id="2">Home</attributeValue> ..... </attributeValueList>
        <collectionInfo defaultJobJacketTicket="Default Job Ticket" defaultJobJacketName="Default Job Jacket" defaultJobJacketId="1" templateId="0" collectionClass="General" collectionClassId="1416" collectionTemplate="false" accessibleChildrenAvailable="true" domainId="19" collectionPath="Home/Collection" name="Collection" id="10">
            <attributeValueList>
                <attributeValue valueId="0" type="numeric" name="Id" id="1">10</attributeValue>
                <attributeValue valueId="0" type="text" name="Name" id="2">Collection</attributeValue> ...... </attributeValueList>
            <collectionInfo defaultJobJacketTicket="Default Job Ticket" defaultJobJacketName="Default Job Jacket" defaultJobJacketId="1" templateId="0" collectionClass="Book" collectionClassId="1403" collectionTemplate="false" accessibleChildrenAvailable="false" domainId="19" collectionPath="Home/Collection/123" name="123" id="14">
                <attributeValueList>
                    <attributeValue valueId="0" type="numeric" name="Id" id="1">14</attributeValue>
                    <attributeValue valueId="0" type="text" name="Name" id="2">123</attributeValue> . ...... </attributeValueList>
            </collectionInfo>
        </collectionInfo>
    </collectionInfo>
</collectionInfoList>
 

getCollectionDefaultJobJacket

Function

Get the default Job Jackets file for a collection.

Description

This request returns the default job jacket set for a collection. Returns null if no job jacket is specified as default for this collection or the content of the job jacket is not found.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollectionDefaultJobJacket

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=defaultjobjacket

string

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

Returns

Returns a jobJacketInfo object with its metadata.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?op=defaultjobjacket

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobJacketInfo id="1">
    <name>Default Job Jacket</name>
    <domainId>0</domainId>
    <defaultTicketTemplate>Default Job Ticket</defaultTicketTemplate>
    <createdBy>1</createdBy>
    <creatorName>Admin</creatorName>
    <created>2008-06-01T10:00:00Z</created>
    <lastModifiedBy>1</lastModifiedBy>
    <lastModifierName>Admin</lastModifierName>
    <lastModified>2008-06-01T10:00:00Z</lastModified>
    <ticketTemplateList>
        <ticketTemplate>Default Job Ticket</ticketTemplate>
    </ticketTemplateList>
    <content> ... </content>
</jobJacketInfo>

getCollectionDefaultTicket

Function

Get the default Job Ticket for a collection.

Description

This request returns the default Job Ticket for the collection.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getCollectionDefaultTicket

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=defaultticket

string

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

Returns

Returns the name of the default job ticket for a collection.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?op=defaultticket

Result:

Default Job Ticket. The name of the default job ticket for a collection.

moveCollection

Function

Move a collection.

Description

This request moves a collection or collection template from one level to another.

Type

POST

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

moveCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=move

string

The op parameter allows you to specify which operation is to be performed. (Mandatory) This request moves a collection along with its child collections and assets under a new parent collection.

targetparent=[collection path or ID]

long or string

The collection to which this collection should be moved. (Mandatory)

Returns

Returns a collectionInfo object of the collection or the collection template with updated metadata.

Examples

URL:

http://serverName:serverPort/rest/service/collections/colTemplate? op=move&targetparent=Home/Collection/XDK

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collectionInfo templateId="0" collectionClass="General" collectionClassId="1416" collectionTemplate="true" accessibleChildrenAvailable="true" domainId="19" name="colTemplate" id="16">
    <attributeValueList>
        <attributeValue type="numeric" name="Id" id="1">1</attributeValue> ... </attributeValueList>
    <workflowInfoList>
        <workflowInfo id="10">
            <name>Workflow1</name> ... <statusInfoList>
                <statusInfo id="10">
                    <name>Status1</name> ... </statusInfo>
            </statusInfoList>
        </workflowInfo> .... ....</workflowInfoList>
</collectionInfo>

duplicateCollection

Function

Duplicate a collection.

Description

This request duplicates a given collection or collection template.

Type

POST

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

duplicateCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=duplicate

string

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

name=[new collection name]

string

The name of the new collection. (Mandatory)

targetparent=[collection path or ID]

long or string

The collection where the duplicate collection should be put. (Mandatory)There is a choice between collection ID, Name and Path when providing a value.

assets=[true or false]

boolean

True to also duplicate assets. Defaults to false.(Optional)

If assets = true, then the metadata flags like duplicateHierarchy, duplicateWorkflows, duplicateMembers, etc will be over written as true.

createminorversion =[true|false]

boolean

This parameter will only work if assets parameter is given. Defaults to false.(Optional)

duphierarachy =[true|false]

boolean

Parameter to duplicate collection with or without its child collections. Defaults to true.(Optional)

dupworkflows =[true|false]

boolean

Parameter to duplicate collection with or without workflows. Defaults to true.(Optional)

dupmembers =[true|false]

boolean

Parameter to duplicate collection with or without users. Defaults to true.(Optional)

duproutings =[true|false]

boolean

Parameter to duplicate collection with or without Status Routing Settings.

Defaults to true.(Optional)

dupjobjackets =[true|false]

boolean

Parameter to duplicate collection with or without JobJackets. Defaults to true.(Optional)

duprevisioncontrols =[true|false]

boolean

Parameter to duplicate collection with or without RevisionControl Settings.

Defaults to true.(Optional)

Returns

Returns the collectionInfo object of the duplicated collection.

Examples

URL:

http://serverName:serverPort/rest/service/collections/24? op=duplicate&name=dup12_Children&targetparent=Home

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collectionInfo templateId="0" collectionClass="General" collectionClassId="1416" collectionTemplate="true" accessibleChildrenAvailable="true" domainId="19" name="dup12_Children" id="17">
    <attributeValueList>
        <attributeValue type="numeric" name="Id" id="1">1</attributeValue> ... </attributeValueList>
    <workflowInfoList>
        <workflowInfo id="10">
            <name>Workflow1</name> ... <statusInfoList>
                <statusInfo id="10">
                    <name>Status1</name> ... </statusInfo>
            </statusInfoList>
        </workflowInfo> .... .... </workflowInfoList>
</collectionInfo>

updateCollection

Function

Update a collection.

Description

This request updates the metadata of a given collection or collection template.

Type

POST

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

updateCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=udpate

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)

workflows =[comma-separated list of workflow names or IDs]

long or string

To update given collection's workflows. To get the IDs of all workflows, use a call to ../admin/workflows. (Optional)

groups=[group name or ID], [group name or ID],...

GroupInfoList

To update given collection's workflows.To get the IDs of all groups, use a call to ../admin/groups. (Optional)

jobjackets =[comma-separated list of Job Jackets IDs]

long or string

To update given collection's JobJackets. To get a list of Job Jackets and their IDs for a collection, use a call to ../collections/colID?jobjackets=true. (Optional)

routings=<xml/>

xml

To update given collection's Status Routing Settings.See "Request/Response parameter formats."(Optional)

ticketname=[name of default Job Ticket]

string

To update given collection's Default JobJacket Ticket Name.To get the name of Job Ticket for a collection, use a call to ../collections/1?op=defaultticket. (Optional)

applytochildren =[true|false]

boolean

Parameter to override settings on its child collection. Defaults to false. (Optional)

If this parameter is supplied, it will override the previous settings on its child collections. Used parameters ( e.g. Workflows) will not be removed in case the used workflow doesn't exist in the newly supplied parameters.

appendtochildren =[true|false]

boolean

Parameter to merge settings on its child collection. (Optional)Defaults to false. true is equivalent to Apply settings to child Collections: Merge in Platform. Supplied parameter settings will be merged to previous settings of its child collections.

users=<xml/>

xml

To update given collection's Users. See "Request/Response parameter formats."(Optional)

revisioncontrols=<xml/>

xml

To update given collection's Revision Control Settings. See "Request/Response parameter formats."(Optional)

Returns

Returns the collectionInfo object of the updated collection.

Examples

URL:

http://serverName:serverPort/rest/service/collections/13? op=update&attributevalues=

<attributeValueList><attributeValue name="name">dup_col</attributeValue></attributeValueList> &workflows=10&users= <userInfoList><userInfo id="1"></userInfo></userInfoList> &groups=Group1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collectionInfo templateId="0" collectionClass="General" collectionClassId="1416" collectionTemplate="true" accessibleChildrenAvailable="true" domainId="19" name="dup12_Children" id="17">
    <attributeValueList>
        <attributeValue type="numeric" name="Id" id="1">1</attributeValue> ... </attributeValueList>
    <workflowInfoList>
        <workflowInfo id="10">
            <name>Workflow1</name> ... <statusInfoList>
                <statusInfo id="10">
                    <name>Status1</name> ... </statusInfo>
            </statusInfoList>
        </workflowInfo> .... ....</workflowInfoList>
</collectionInfo>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collectionInfo templateId="0" collectionClass="General" collectionClassId="1416" collectionTemplate="false" accessibleChildrenAvailable="false" domainId="19" collectionPath="Home/Collection/XDK/dup_col" name="dup_col" id="13">
    <attributeValueList>
        <attributeValue valueId="0" type="numeric" name="Id" id="1">13</attributeValue>
        <attributeValue valueId="0" type="text" name="Name" id="2">dup_col</attributeValue> . ..... </attributeValueList>
    <workflowInfoList>
        <workflowInfo id="10">
            <name>Workflow1</name>
            <domainId>18</domainId>
            <created>2013-12-23T12:06:33Z</created>
            <createdBy>1</createdBy>
            <lastModifiedBy>1</lastModifiedBy>
            <lastModified>2013-12-23T12:06:33Z</lastModified>
        </workflowInfo>
    </workflowInfoList> ....... </collectionInfo>

updateCollections

Function

Update multiple collections.

Description

This request updates multiple collections in a single request.

Type

POST

URL Format

.../collections

Java API

Method Name

Class Name

updateCollections

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=update

string

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

This operation will run only for a valid session id.

collectioninfolist=<xml/>

 

See "Request/Response parameter formats."

Returns

Returns a collectioninfolist object in XML format that contains the metadata of all successfully updated collections.

Examples

URL:

https://serverName:serverPort/rest/service/collections?op=update&collectioninfolist=

<?xml version="1.0" encoding="UTF-8"?>
<collectionInfoList>
    <collectionInfo collectionClassId="1416" collectionTemplate="false" collectionPath="Home/Home3">
        <attributeValueList>
            <attributeValue valueId="0" type="text" name="Name" id="2">Home3</attributeValue>
            <attributeValue valueId="0" type="dateTime" name="Created" id="3">2010-04-01T10:00:00Z</attributeValue>
            <attributeValue valueId="0" type="dateTime" name="Last modified" id="4">2010-04-01T10:00:00Z</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="boolean" name="Is Template" id="59">false</attributeValue>
            <attributeValue valueId="0" type="text" name="Collection Path" id="57">Home/Home1</attributeValue>
            <attributeValue valueId="1416" type="popup" name="Content Type" id="62">General</attributeValue>
            <attributeValue valueId="0" type="text" name="Content Type Hierarchy" id="63">System;Collection;General</attributeValue>
        </attributeValueList>
    </collectionInfo>
</collectionInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collectionInfoList>
    <collectionInfo defaultJobJacketTicket="Default Job Ticket" defaultJobJacketName="Default Job Jacket" defaultJobJacketId="1" templateId="0" collectionClass="General" collectionClassId="1416" collectionTemplate="false" accessibleChildrenAvailable="false" domainId="19" collectionPath="Home/Home3" name="Home3" id="23">
        <attributeValueList>
            <attributeValue valueId="0" type="numeric" name="Id" id="1">23</attributeValue>
            <attributeValue valueId="0" type="text" name="Name" id="2">Home3</attributeValue>
            <attributeValue valueId="0" type="dateTime" name="Created" id="3">2014-04-10T06:09:46Z</attributeValue> .... </attributeValueList>
        <workflowInfoList/>
        <routingInfoList/>
        <userInfoList>
            <userInfo id="1">
                <name>Admin</name> ..... </userInfo>
        </userInfoList>
        <groupInfoList/>
        <jobJacketInfoList>
            <jobJacketInfo id="1">
                <name>Default Job Jacket</name> ..... </jobJacketInfo>
        </jobJacketInfoList>
    </collectionInfo>
    <collectionInfo> ....... </collectionInfo>
</collectionInfoList>

deleteCollection

Function

Delete a collection.

Description

This request deletes the specified collection or collection template.

Type

POST

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

deleteCollection

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=delete

string

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

This request works only for empty collections. This means a collection can only be deleted if the collection and all of its child collection do not have any assets in them.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/collections/142?op=delete

deleteCollectionWithAssets

Function

Delete a collection with assets.

Description

This request deletes the given collection from the system along with its sub-collections and assets. Only users who have access to the given collection are allowed to delete the collection.

Type

POST

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

deleteCollectionWithAssets

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=deletewithassets

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/collections/142?op=deletewithassets

createJobjackets

Function

Create a Job Jackets file.

Description

This request creates new job jacket after parsing the content supplied and returns and object of the newly created Job Jacket. Stream the Job Jackets XML into the request body or send it as a file part.

Type

POST

URL Format

.../collections/jobjackets

Java API

Method Name

Class Name

createJobjackets

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=create:

string

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

Returns

Returns a jobJacketInfoList object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/collections/jobjackets?op=create

Result:

A jobJacketInfoList object in XML format.

getJobjacket

Function

Get a Job Jackets file with a specific ID.

Description

This request returns the specified job jacket.

Type

GET

URL Format

.../collections/jobjackets/[Job Jackets ID]

Java API

Method Name

Class Name

getJobjacket

com.quark.qpp.service.facade Class CollectionFacade

Parameters

This request requires no input parameters.

Returns

Returns a jobJacketInfoList object with its metadata.

Examples

URL:

http://serverName:serverPort/rest/service/collections/jobjackets/1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobJacketInfoList>
    <jobJacketInfo id="1">
        <name>Default Job Jacket</name>
        <domainId>0</domainId>
        <defaultTicketTemplate>Default Job Ticket</defaultTicketTemplate>
        <createdBy>1</createdBy>
        <creatorName>Admin</creatorName>
        <created>2008-06-01T10:00:00Z</created>
        <lastModifiedBy>1</lastModifiedBy>
        <lastModifierName>Admin</lastModifierName>
        <lastModified>2008-06-01T10:00:00Z</lastModified>
        <ticketTemplateList>
            <ticketTemplate>Default Job Ticket</ticketTemplate>
        </ticketTemplateList>
        <content>.... </content>
    </jobJacketInfo>
</jobJacketInfoList>

getAllJobJackets

Function

Get all Job Jackets.

Description

This request returns all the metadata of Job Jackets available in the system.

Type

GET

URL Format

.../collections/jobjackets

Java API

Method Name

Class Name

getAllJobJackets

com.quark.qpp.service.facade Class CollectionFacade

Parameters

This request requires no input parameters.

Returns

Returns a jobJacketInfoList object that contains a list of Job Jackets.

Examples

URL:

http://serverName:serverPort/rest/service/collections/jobjackets

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobJacketInfoList>
    <jobJacketInfo id="1">
        <name>Default Job Jacket</name>
        <domainId>0</domainId>
        <defaultTicketTemplate>Default Job Ticket</defaultTicketTemplate>
        <createdBy>1</createdBy>
        <creatorName>Admin</creatorName>
        <created>2008-06-01T10:00:00Z</created>
        <lastModifiedBy>1</lastModifiedBy>
        <lastModifierName>Admin</lastModifierName>
        <lastModified>2008-06-01T10:00:00Z</lastModified>
        <ticketTemplateList>
            <ticketTemplate>Default Job Ticket</ticketTemplate>
        </ticketTemplateList>
        <content>.........</content>
    </jobJacketInfo> ........... </jobJacketInfoList>

getJobJacketContent

Function

Get the contents of a Job Jackets file.

Description

This request returns the actual content of a specified job jacket in xml format.

Type

GET

URL Format

.../collections/[collection ID] or collectionsbypath/[collection path]

Java API

Method Name

Class Name

getJobJacketContent

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=jobjacketcontent

string

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

jobjacket=[Job Jackets file ID]

 

To get a list of Job Jackets and their IDs for a collection, use a call to ../collections/colID?jobjackets=true. (Mandatory)

Returns

Returns the actual content of a specified job jacket in XML format

Examples

URL:

http://serverName:serverPort/rest/service/collections/1?op=jobjacketcontent&jobjacket=1

Result:

<?xml version="1.0" encoding="UTF-8"?>
<JDF xmlns="http://www.CIP4.org/JDFSchema_1_1" xmlns:qxp="http://www.quark.com/QuarkXPress/JDF_1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.2" JacketVersion="1.0" ID="QuarkXPressDefault_Job_Jacket" Type="QuarkXPressJacket" xsi:type="qxp:QuarkXPressJacket" Status="Waiting" Name="Default Job Jacket" Template="true">
    <ResourcePool> </ResourcePool>
    <JDF Name="Default Job Ticket" ID="JobTicket_0" IsDefault="1" Status="Waiting" Template="true" Type="QuarkXPressTemplateTicket" xsi:type="qxp:QuarkXPressTemplateTicket">
        <ResourceLinkPool> </ResourceLinkPool>
        <ResourcePool> </ResourcePool>
    </JDF>
</JDF>

updateJobJacket

Function

Update a job jacket.

Description

This request updates the contents of a specified job jacket.

Type

POST

URL Format

.../collections/jobjackets/[jobJacketId]

Java API

Method Name

Class Name

updateJobJacket

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=update

string

The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id.Pass the xml of the job jacket file as file stream in the request body.

Returns

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

Examples

URL:

http://serverName:serverPort/collections/jobjackets/{jobJacketId}?op=update

updateJobJackets

Function

Update multiple job jackets

Description

This request updates the contents of multiple job jackets in a single request.

Type

POST

URL Format

.../collections/jobjackets

Java API

Method Name

Class Name

updateJobJackets

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=update

string

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

This operation will run only for a valid session id.

jobjacketinfolist=<xml/>

 

See "Request/Response parameter formats."

Returns

Returns a jobjacketinfolist object in XML format that contains the metadata of all successfully updated job jackets.

Examples

URL:

http://serverName:serverPort/collections/jobjackets?op=update&jobjacketinfolist=<xml />

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobJacketInfoList>
    <jobJacketInfo id="1">
        <name>Default Job Jacket</name>
        <domainId>0</domainId>
        <defaultTicketTemplate>Default Job Ticket</defaultTicketTemplate>
        <createdBy>1</createdBy>
        <creatorName>Admin</creatorName>
        <created>2008-06-01T10:00:00Z</created>
        <lastModifiedBy>1</lastModifiedBy>
        <lastModifierName>Admin</lastModifierName>
        <lastModified>2008-06-01T10:00:00Z</lastModified>
        <ticketTemplateList>
            <ticketTemplate>Default Job Ticket</ticketTemplate>
        </ticketTemplateList>
        <content>&lt;?xml version="1.0" encoding="UTF-8"?>&lt;JDF xmlns="http://www.CIP4.org/JDFSchema_1_1" xmlns:qxp="http://www.quark.com/QuarkXPress/JDF_1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.2" JacketVersion="1.0" ID="QuarkXPressDefault_Job_Jacket" Type="QuarkXPressJacket" xsi:type="qxp:QuarkXPressJacket" Status="Waiting" Name="Default Job Jacket" Template="true"> &lt;ResourcePool>&lt;/ResourcePool> &lt;JDF Name="Default Job Ticket" ID="JobTicket_0" IsDefault="1" Status="Waiting" Template="true" Type="QuarkXPressTemplateTicket" xsi:type="qxp:QuarkXPressTemplateTicket"> &lt;ResourceLinkPool>&lt;/ResourceLinkPool> &lt;ResourcePool>&lt;/ResourcePool> &lt;/JDF>&lt;/JDF> </content>
    </jobJacketInfo>
</jobJacketInfoList>

parseJobJacketXml

Function

Parse a Job Jackets file. (Include the file in the request body or as file part.)

Description

This request parses the jobjacket xml and returns a JobJacket object containing the jobjacket name and ticket names.

Type

POST

URL Format

.../collections/jobjackets

Java API

Method Name

Class Name

parseJobJacketXml

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=parsexml

string

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

Returns

Returns a jobjacketinfo object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/collections/jobjackets?op=parsexml

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobJacketInfo id="0">
    <name>Project1 Job Jacket</name>
    <domainId>0</domainId>
    <defaultTicketTemplate>Default Job Ticket</defaultTicketTemplate>
    <createdBy>0</createdBy>
    <lastModifiedBy>0</lastModifiedBy>
    <ticketTemplateList>
        <ticketTemplate>Default Job Ticket</ticketTemplate>
    </ticketTemplateList>
</jobJacketInfo>

deleteJobJacket

Function

Delete a Job Jackets file.

Description

This request deletes the jobjacket with the given id.

Type

POST

URL Format

.../collections/jobjackets/[Job Jacket ID]

Java API

Method Name

Class Name

deleteJobJacket

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

op=delete

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/collections/jobjackets/10?op=delete

getApplicableRoutingUsers

Function

Get Applicable Routing Users

Description

This request returns a list of applicable routing users for the given collection for specified workflow and status. This will return all collection mapped users having the same userclass as any of the status mapped userclasses.

Type

GET

URL Format

.../collections/{collectionId}

Java API

Method Name

Class Name

getApplicableRoutingUsers

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

routingusers =true

boolean

 

workflow={workflowIdOrName}

string

The ID or Name of the workflow whose Routing Users you wish to be retrieved.

status={statusIdOrName} or workflowStatusCombination

string

The ID or Name of the status whose Routing Users you wish to be retrieved.

Returns

Returns an userInfoList object containing a list of all collection users applicable for given workflow or status.

Examples

URL:

http://serverName:serverPort/rest/service/collections/ 1?routingusers=true&status=Status1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="1">
        <name>Admin</name>
        <firstName>Administrator</firstName>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo> .... </userInfoList>

getApplicablePrivileges

Function

Get applicable privileges for the logged in user.

Description

This request returns the privileges applicable for the logged in user for the given collection. These privileges are a union of the privileges of the following user clases:Userclass of the logged in user in the given collection, only if the user is mapped to the given collection.Userclasses of collection mapped groups of which the logged in user is a member.

Type

GET

URL Format

.../collections/[collection ID]

Java API

Method Name

Class Name

getApplicablePrivileges

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

applicableprivileges=[true]

boolean

 

status=[statusId] or [Name] or [StatusWorkFlowCombination]

long

The ID or Name of the status whose privileges you wish to be retrieved.

contenttype=[contenTypeId] or [Name] or [Path]

long

The default content type IDs are documented in the JavaDoc SDK at com.quark.qpp.core. content.service.constants.DefaultContentTypes. To get a list of content types, use a call to ../admin/contenttypes.(Optional)

If not provided, the metadata of all conent types will be returned.

privileges=[comma-separated list of privilege ids or names]

string

 

Returns

Returns a applicablePrivilegesInfo object containing either application and content level privileges or both, depending upong the parameters.

Examples

URL:

http://serverName:serverPort/rest/service/collections/192? applicableprivileges=true

Result:

<applicablePrivilegesInfo>
    <applicationPrivList>
        <privilege id="140000023">
            <name>Delete</name>
            <privilegeHierarchy> Administration;Storage;StorageRules;Delete </privilegeHierarchy>
        </privilege>
        <privilege id="140000022">
            <name>Create/Modify</name>
            <privilegeHierarchy> Administration;Storage;StorageRules;Create/Modify </privilegeHierarchy>
        </privilege> ...... </applicationPrivList>
    <contentTypePrivList>
        <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
            <privilege id="3000006">
                <name>Change Workflow of Checked In Asset</name>
                <privilegeHierarchy> Edit Attributes;Change Workflow of Checked In Asset </privilegeHierarchy>
            </privilege> ..... </contentTypePriv>
    </contentTypePrivList>
</applicablePrivilegesInfo>

Function

Get enabled content type privileges.

Description

This request returns only contenttype based privileges applicable for the logged in user for the given collection. These privileges are a union of the privileges of the following user clases:Userclass of the logged in user in the given collection, only if the user is mapped to the given collection.Userclasses of collection mapped groups of which the logged in user is a member.

Type

GET

URL Format

.../collections/[collection ID]

Java API

Method Name

Class Name

getApplicablePrivileges

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

applicableprivileges=[true]

boolean

(Mandatory)

contenttype=[contenTypeId] or [Name] or [Path]

long

The default content type IDs are documented in the JavaDoc SDK at com.quark.qpp.core. content.service.constants.DefaultContentTypes. To get a list of content types, use a call to ../admin/contenttypes.(Optional)

If not provided, the metadata of all conent types will be returned.

Returns

Returns a applicablePrivilegesInfo object containing either application and content level privileges or both, depending upong the parameters.

Examples

URL:

http://serverName:serverPort/rest/service/collections/192 ?applicableprivileges=true&contenttype=Picture

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<applicablePrivilegesInfo>
    <contentTypePrivList>
        <contentTypePriv contentTypeId="1103" contentType="Picture" contentTypeHierarchy="System;Asset;Picture;">
            <privilege id="10000015">
                <name>Get Original Assets</name>
                <privilegeHierarchy>General;Get Original Assets</privilegeHierarchy>
            </privilege>
            <privilege id="10000012">
                <name>Check In Asset without Displaying the Check In Dialog Box</name>
                <privilegeHierarchy> General;Check In Asset without Displaying the Check In Dialog Box </privilegeHierarchy>
            </privilege>....................
        </contentTypePriv>
    </contentTypePrivList>
</applicablePrivilegesInfo>

Function

Get all enabled status privileges.

Description

This request returns the privileges applicable for the logged in user for the given collection and status (Status based overridden privileges) . These privileges are a union of the privileges of the following user clases: Userclass of the logged in user in the given collection, only if the user is mapped to the given collection.Userclasses of collection mapped groups of which the logged in user is a member.

Type

GET

URL Format

.../collections/[collection ID]

Java API

Method Name

Class Name

getApplicablePrivileges

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

applicableprivileges=[true]

boolean

 

status=[statusId] or [Name] or [StatusWorkFlowCombination]

boolean

The ID or Name of the status whose privileges you wish to be retrieved.

privileges=[comma-separated list of privilege ids or names]

long or string

 

Returns

Returns a applicablePrivilegesInfo object containing either application and content level privileges or both, depending upong the parameters.

Examples

URL:

http://serverName:serverPort/rest/service/collections/192 ?applicableprivileges=true&status=10&privileges=...,...,...

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<applicablePrivilegesInfo>
    <contentTypePrivList>
        <contentTypePriv contentTypeId="1103" contentType="Picture" contentTypeHierarchy="System;Asset;Picture;">
            <privilege id="10000015">
                <name>Get Original Assets</name>
                <privilegeHierarchy>General;Get Original Assets</privilegeHierarchy>
            </privilege>
            <privilege id="10000012">
                <name>Check In Asset without Displaying the Check In Dialog Box</name>
                <privilegeHierarchy> General;Check In Asset without Displaying the Check In Dialog Box </privilegeHierarchy>
            </privilege> ..........</contentTypePriv>    </contentTypePrivList>
</applicablePrivilegesInfo>
 

getApplicableRoutingGroups

Function

Get applicable routing groups for the logged in user.

Description

This request returns an array of applicable routings groups for the given collection for the specified workflow and status. This will return all collection mapped groups whose userclass is the same as one of the status mapped userclasses.

Type

GET

URL Format

.../collections/[collection ID]

Java API

Method Name

Class Name

getApplicableRoutingGroups

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

routinggroups=[true]

boolean

 

workflow=[Id] or [Name]

long or string

The ID or Name of the workflow whose routing groups you wish to be retrieved.

status=[statusId] or [Name] or [StatusWorkFlowCombination]

long or string

The ID or Name of the status whose routing groups you wish to be retrieved.

Returns

Returns a list of applicable routing GroupInfo objects for the given collection and status.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1 ?routinggroups=true&workflow=Default Workflow&status=Edit

Result:

<groupInfoList>
    <groupInfo id="60">
        <name>Editors</name>
        <emailAddress/>
        <nativeTrustee>true</nativeTrustee>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
    </groupInfo>
</groupInfoList>

getApplicableAttributeConstraints

Function

Get applicable attribute constraints for the logged in user.

Description

This request returns attribute constraints applicable to the given status and collection for the logged in user. The user may have multiple userclasses, due to its membership in multiple groups which are mapped to the collection with different userclasses. Since attribute constraints are defined per userclass, multiple constraints in such cases are evaluated and the most permissive set of attribute constraints is returned.

Type

GET

URL Format

.../collections/[collection ID]

Java API

Method Name

Class Name

getApplicableAttributeConstraints

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

applicableconstraints=[true]

boolean

 

status=[statusId] or [Name] or [StatusWorkFlowCombination]

long or string

The ID or Name of the status whose attributes constraints you wish to be retrieved.

attributes=[comma-separated list of attributes ids or names]

long or string

 

Returns

Returns a list of applicable AttributeConstraintsInfo objects.

Examples

URL:

http://serverName:serverPort/rest/service/collections/191 ?applicableconstraints=true&status=Default Workflow&attributes=2,...,...

Result:

<attributeConstraintsInfoList>
    <attributeConstraintsInfo>
        <attributeId>2</attributeId>
        <attributeName>Name</attributeName>
        <constraintId>1</constraintId>
        <constraintName>PREVENT CHANGE</constraintName>
    </attributeConstraintsInfo> ..... </attributeConstraintsInfoList>

getApplicableStatusTransition

Function

Get applicable status transitions for the logged in user.

Description

This request returns the applicable status transition for the given workflow, status and collection for the logged in user. If the status transition is overridden for the given userclass, then overridden will be considered.

Type

GET

URL Format

.../collections/[collection ID]

Java API

Method Name

Class Name

getApplicableStatusTransition

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

statustransitions=[true]

boolean

 

workflow=[workflowId] or [Name]

long or string

The ID or Name of the workflow whose status transitions you wish to be retrieved.

status=[statusId] or [Name]

long or string

The ID or Name of the status whose status transitions you wish to be retrieved.

Returns

Returns a statusTransitionInfoList object containing a list of applicable status transitions.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1 ?statustransitions=true&workflow=Default Workflow

Result:

<statusTransitionInfoList>
    <statusTransitionInfo id="10">
        <name>Edit</name>
        <workflowInitiatingStatus>true</workflowInitiatingStatus>
        <nextPossibleStatusInfoList>
            <nextPossibleStatusInfo id="11">
                <name>Publish</name>
            </nextPossibleStatusInfo>
        </nextPossibleStatusInfoList>
    </statusTransitionInfo>
    <statusTransitionInfo id="11">
        <name>Publish</name>
        <workflowInitiatingStatus>true</workflowInitiatingStatus>
        <nextPossibleStatusInfoList>
            <nextPossibleStatusInfo id="10">
                <name>Edit</name>
            </nextPossibleStatusInfo>
        </nextPossibleStatusInfoList>
    </statusTransitionInfo>
</statusTransitionInfoList>

getApplicableWorkflowInitialStatuses

Function

Get applicable workflow initial statuses.

Description

This request returns the initial applicable statuses for the given workflow and collection.

Type

GET

URL Format

.../collections/[collection ID]

Java API

Method Name

Class Name

getApplicableWorkflowInitialStatuses

com.quark.qpp.service.facade Class CollectionFacade

Parameters

Name

Type

Description

workflowinitiatingstatuses=[true]

boolean

 

workflow=[workflowId] or [Name]

long or string

The ID or Name of the workflow whose workflow Initiating Statuses you wish to be retrieved.

Returns

Returns a list of StatusInfo objects referring to the initial applicable statuses.

Examples

URL:

http://serverName:serverPort/rest/service/collections/1 ?workflowinitiatingstatuses=true&workflow=Default Workflow

Result:

<statusInfoList>
    <statusInfo id="10">
        <name>Edit</name> ............ </statusInfo>
    <statusInfo id="11">
        <name>Publish</name> ............. </statusInfo>
</statusInfoList>