Rest Interface Guide

Administration

The administration capabilities of the API allow application developers to perform administrative tasks and includes the following REST calls:

createUsers

Function

Create users.

Description

This request is used to create users. The new user will be created without a password, client needs to set the password for the user separately.

Type

POST

URL Format

.../admin/users

Java API

Method Name

Class Name

createUsers

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

userinfolist

 

Object containing a list of the users (userInfo) to be created.

See the userInfoList paramater in "Request/Response parameter formats".

The following are mandatory attributes required to create a user:

  • Name

  • DefaultUserClass

  • Enabled,NativeTrustee

  • DefaultUserClassId

Returns

Returns a userInfoList object containing metadata of a newly created user.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users?op=create&userinfolist=

<?xml version="1.0" encoding="UTF-8"?>
<userInfoList>
    <userInfo>
        <name>SampleQPPGroup</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="14">
        <name>SampleQPPGroup</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>
Example with multiple usersURL:http://serverName:serverPort/rest/service/admin/users?op=create&userinfolist= <?xml version="1.0" encoding="UTF-8"?>
<userInfoList>
    <userInfo>
        <name>SampleQPPGroup1</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
    <userInfo>
        <name>SampleQPPGroup2</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>
Result: <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="14">
        <name>SampleQPPGroup1</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
    <userInfo id="15">
        <name>SampleQPPGroup2</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>

getUser

Function

Get specific user.

Description

This request is used to fet the metadata of a specified user.

Type

GET

URL Format

.../admin/users/[userIdORuserName]

Java API

Method Name

Class Name

getUser

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters

Returns

Returns an userInfoList object with its metadata.

Examples

URL:

http://serverName:serverPort/rest/service/users/Admin

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>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>

getAllUsers

Function

Get all users.

Description

This request is used to fetch all users.

Type

GET

URL Format

.../admin/users

Java API

Method Name

Class Name

getAllUsers

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters

Returns

Returns an userInfoList object containing metadata of users in the form of an array.

Examples

URL:

http://serverName:serverPort/rest/service/users

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="1">
        <name>Admin</name>
        <domainId>0</domainId>
        <firstName>Administrator</firstName>
        <phoneNumber>+911722299000</phoneNumber>
        <emailAddress>platformadmin@quark.com</emailAddress>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <user>true</user>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
        <overriddenUserClassId>0</overriddenUserClassId>
    </userInfo>
</userInfoList>

getUsersWithGivenUserClass

Function

Get users with the default given userclass.

Description

This request returns the platform users with the specified user class.

Type

GET

URL Format

../admin/roles/{roleIdORroleName}

Java API

Method Name

Class Name

getUsersWithGivenUserClass

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

users

string

true

Returns

Returns a userInfoList containing metadata of all the users belonging to the specified userClass in array format.

Examples

URL:

http://serverName:serverPort/rest/service/admin/roles/Administrator?users=true

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="1">
        <name>Admin</name>
        <domainId>0</domainId>
        <firstName>Administrator</firstName>
        <emailAddress>qppadministrator@quark.com</emailAddress>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <user>true</user>
        <deleted>false</deleted>
        <overriddenUserClassId>0</overriddenUserClassId>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
    <userInfo id="10">
        <name>Admin2</name> ...... </userInfo>
</userInfoList>

getAllUserRedliningColor

Function

Get a list of all users along with redline colors.

Description

This request returns a list of all the users along with their redlining colors.

Type

GET

URL Format

.../redline

Java API

Method Name

Class Name

getAllUserRedliningColor

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns list of all the users along with their redlining colors.

Examples

URL:

http://serverName:serverPort/rest/service/admin/redline

Result:

<redlineInfoList>
    <redlineInfo>
        <color blue="0" green="0" red="0"/>
        <user id="11">BOT</user>
    </redlineInfo>
    <redlineInfo>
        <color blue="0" green="0" red="0"/>
        <user id="1">Admin</user>
    </redlineInfo>
    <redlineInfo>
        <color blue="0" green="0" red="0"/>
        <user id="10">Admin2</user>
    </redlineInfo>
</redlineInfoList>

Function

Get Redline color for a given user.

Description

This request returns the defined redlining color for the given user.

Type

GET

URL Format

.../redline

Java API

Method Name

Class Name

getAllUserRedliningColor

com.quark.qpp.service.facadeClass AdminFacade

Parameters

Name

Type

Description

user

string

Name of the user for which redline color information is to be fetched.

Returns

Returns the defined redlining color for the given user.

Returns specific privilege(s) in system with given id or name. If privilege name is specified and there exists multiple privileges in different privilege groups, with the given name, list of all such privileges will be returned.

Examples

URL:

http://serverName:serverPort/rest/service/admin/redline?user=Admin

Result:

<redlineInfoList>
    <redlineInfo>
        <color blue="252" green="8" red="126"/>
        <user id="1">Admin</user>
    </redlineInfo>
</redlineInfoList>

updateUserRedliningColor

Function

Updates the redlining color for the given user(s).

Description

This request updates the redlining color for the given user(s).

Type

POST

URL Format

.../redline? op=update

Java API

Method Name

Class Name

updateUserRedliningColor

com.quark.qpp.service.facadeClass AdminFacade

Parameters

Name

Type

Description

redlineinfolist= <XML/>

string

A redLineInfoList object in XML format. See "Request/Response parameter formats."

Returns

Returns the defined redlining color for the given user(s).

Examples

URL:

http://serverName:serverPort/rest/service/admin/redline?user=BOT

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<redlineInfoList>
    <redlineInfo>
        <color blue="10" green="56" red="115"/>
        <user id="11">BOT</user>
    </redlineInfo>
</redlineInfoList>

updateUserEnabled

Function

Enables/disables the Platform Server Logon for the given user.

Description

This request enables/disables the Platform Server logon for the given user.

Type

POST

URL Format

.../admin/users/{userIdOrName}

Java API

Method Name

Class Name

updateUserEnabled

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=setenabled

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.

enabled=[True] or [False]

boolean

 

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/users/ John?op=setenabled&enabled=true:

updateUsers

Function

Update users.

Description

This request is used to update a single user or multiple users at one time.

Type

POST

URL Format

..../admin/users

Java API

Method Name

Class Name

updateUsers

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

userinfolist=<xml/>

 

Object containing a list of the successfully updated users .

Returns

Returns a UserInfoList object containing a list of all the successfully updated users.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users?userinfolist=

<userInfoList>
    <userInfo id="33">
        <name>Tom</name>
        <firstName>Tom</firstName>
        <lastName>Rodrigues</lastName>
        <nativeTrustee>true</nativeTrustee>
        <enabled>false</enabled>
        <defaultUserClassId>12</defaultUserClassId>
        <defaultUserClass>Editor</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="33">
        <name>Tom</name>
        <firstName>Tom</firstName>
        <lastName>Rodrigues</lastName>
        <nativeTrustee>true</nativeTrustee>
        <enabled>false</enabled>
        <defaultUserClassId>12</defaultUserClassId>
        <defaultUserClass>Editor</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>

Example with multiple content types

URL:

http://serverName:serverPort/rest/service/admin/users?userinfolist=

<userInfoList>
    <userInfo id="33">
        <name>Tom</name>
        <firstName>Tom</firstName>
        <lastName>Rodrigues</lastName>
        <nativeTrustee>true</nativeTrustee>
        <enabled>false</enabled>
        <defaultUserClassId>12</defaultUserClassId>
        <defaultUserClass>Editor</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
    <userInfo id="34">
        <name>Sam</name>
        <firstName>Sam</firstName>
        <lastName>Rodrigues</lastName>
        <nativeTrustee>true</nativeTrustee>
        <enabled>false</enabled>
        <defaultUserClassId>12</defaultUserClassId>
        <defaultUserClass>Editor</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="33">
        <name>Tom</name>
        <firstName>Tom</firstName>
        <lastName>Rodrigues</lastName>
        <nativeTrustee>true</nativeTrustee>
        <enabled>false</enabled>
        <defaultUserClassId>12</defaultUserClassId>
        <defaultUserClass>Editor</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
    <userInfo id="34">
        <name>Sam</name>
        <firstName>Sam</firstName>
        <lastName>Rodrigues</lastName>
        <nativeTrustee>true</nativeTrustee>
        <enabled>false</enabled>
        <defaultUserClassId>12</defaultUserClassId>
        <defaultUserClass>Editor</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
        <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    </userInfo>
</userInfoList>

deleteUser

Function

Delete a user.

Description

This request is used to delete the specified user.

Type

POST

URL Format

.../admin/users/[userIdORName]

Java API

Method Name

Class Name

deleteUser

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

userIdORName

 

Id or Name of the user to be deleted.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/users/32?op=delete

createGroups

Function

Create groups.

Description

This request is used to create a single or multiple groups at one time.

Type

POST

URL Format

.../admin/groups

Java API

Method Name

Class Name

createGroups

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

groupinfolist

 

Object containing list of groups to be created. See "Request/Response parameter formats."

Returns

Returns a groupInfoList object containing its metadata and memberlist.

Examples

URL:

http://serverName:serverPort/rest/service/admin/groups?op=create &groupInfo=

<groupInfoList>
    <groupInfo>
        <name>Editorial</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>
                <name>Admin</name>
            </nameId> ..... </memberList>
    </groupInfo>
</groupInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfo id="48">
    <name>SampleQPdzxcdPGroup</name>
    <domainId>0</domainId>
    <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"/>
        <nameId id="10" name="Admin2"/>
    </memberList>
</groupInfo>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoList>
    <groupInfo id="20">
        <name>Editoria</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>
    </groupInfo>
</groupInfoList>

Multiple Groups Example:

URL:

http://serverName:serverPort/rest/service/admin/groups?op=create&groupinfolist=

<groupInfoList>
    <groupInfo>
        <name>Department</name>
        <deleted>false</deleted>
        <memberList>
            <nameId id="1">
                <name>Admin</name>
            </nameId> ........... </memberList>
    </groupInfo>
    <groupInfo>
        <name>Production</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>
    </groupInfo>
</groupInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoList>
    <groupInfo id="21">
        <name>Department</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>
    </groupInfo>
    <groupInfo id="22">
        <name>Production</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>
    </groupInfo>
</groupInfoList>

getGroup

Function

Get a group with a particular ID or Name.

Description

This request returns all the metadata of specified group.

Type

GET

URL Format

.../admin/groups/[groupIDORgroupName]

Java API

Method Name

Class Name

getGroup

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a groupInfoList object in XML format of specified group. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/admin/groups/21

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoList>
    <groupInfo id="21">
        <name>Department</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>
    </groupInfo>
</groupInfoList>

getAllGroups

Function

Get all groups.

Description

This request returns all groups includin its members.

Type

GET

URL Format

.../admin/groups

Java API

Method Name

Class Name

getAllGroups

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a groupInfoList object containing an array of groups that exist on the QPP server. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/admin/groups

Result:

<groupInfoList>
    <groupInfo>
        <name>gp34</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 name="Sam"/>
            <nameId id="1"/>
        </memberList>
    </groupInfo>
    <groupInfo>
        <name>gp35</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 name="Sam"/>
            <nameId id="1"/>
        </memberList>
    </groupInfo>
</groupInfoList>

getGroupsWithGivenUserClass

Function

Get groups with the given role.

Description

This request returns the Platform Server groups with the given role.

Type

GET

URL Format

.../admin/roles/{roleIdOrName}

Java API

Method Name

Class Name

getGroupsWithGivenUserClass

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

groups=[true]

boolean

 

Returns

Returns a groupInfoList object containing a list of groups that have the default role.

Examples

URL:

http://serverName:serverPort/rest/service/admin/roles/Administrator? groups=true

Result:

<groupInfoList>
    <groupInfo id="12">
        <name>Editors</name>
        <nativeTrustee>true</nativeTrustee>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <memberList>
            <nameId id="3680">
                <name>John</name>
            </nameId>
        </memberList>
    </groupInfo>
    <groupInfo id="13">
        <name>Publishers</name>
        <nativeTrustee>true</nativeTrustee>
        <defaultUserClass>Administrator</defaultUserClass>
        <memberList>
            <nameId id="10">
                <name>Mathias</name>
            </nameId> ...... </memberList>
    </groupInfo>
</groupInfoList>

getUserGroups

Function

Get groups of a user.

Description

This request returns all groups to which the given user belongs.

Type

GET

URL Format

.../admin/users/{userIdOrName}

Java API

Method Name

Class Name

getUserGroups

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

userIdOrName

string

 

Returns

Returns a groupInfoList object containing a list of groups of which the given user is a member.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users/John?groups=true

Result:

<groupInfoList>
    <groupInfo id="12">
        <name>Editors</name>
        <nativeTrustee>true</nativeTrustee>
        <defaultUserClassId>123/defaultUserClassId></defaultUserClassId>
        <defaultUserClass>Editors</defaultUserClass>
    </groupInfo>
    <groupInfo id="3681">
        <name>QPP Server</name>
        <nativeTrustee>false</nativeTrustee>
        <defaultUserClassId>10/defaultUserClassId></defaultUserClassId>
        <defaultUserClass>UserClass2</defaultUserClass>
        <ldapProfileId>764</ldapProfileId>
        <ldapProfile>QPP LDAP Profile</ldapProfile>
        <ldapDistinguishedName> CN=QPP Server,OU=DistributionLists,OU=QMHI,DC=india,DC=quark,DC=com </ldapDistinguishedName>
    </groupInfo>
</groupInfoList>

updateGroups

Function

Update groups.

Description

This request is used to update a single or multiple groups at one time.

Type

POST

URL Format

.../admin/groups

Java API

Method Name

Class Name

updateGroups

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

groupinfolist

XML

Object containing information for single or multiple groups. See "Request/Response parameter formats."

Returns

Returns a groupInfoList object containing a list of all successfully updated groups.

Examples

URL:

http://serverName:serverPort/rest/service/admin/groups?op=update&groupInfo=

<groupInfoList>
    <groupInfo id="22">
        <name>Production</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>
    </groupInfo>
</groupInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoList>
    <groupInfo id="22">
        <name>Production</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>
    </groupInfo>
</groupInfoList>

Example with multiple groups:

URL:

http://serverName:serverPort/rest/service/admin/groups?op=update&groupInfo=

<groupInfoList>
    <groupInfo id="21">
        <name>Department</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>
    </groupInfo>
    <groupInfo id="20">
        <name>Editoria</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>
    </groupInfo>
</groupInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupInfoList>
    <groupInfo id="21">
        <name>Department</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>
    </groupInfo>
    <groupInfo id="20">
        <name>Editoria</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>
    </groupInfo>
</groupInfoList>

deleteGroup

Function

Delete a group.

Description

This request is used to delete the group with the given id or name.

Type

POST

URL Format

..../admin/group/[groupIdORgroupName]

Java API

Method Name

Class Name

deleteGroup

com.quark.qpp.service.facade Class AdminFacade

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/admin/groups/[groupIdORgroupName]?op=delete

createContentTypes

Function

Create content types.

Description

This request is used to create one or more content types and its child content types according to the parent content type ID.

Type

POST

URL Format

.../admin/contenttypes

Java API

Method Name

Class Name

createContentTypes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

contenttypeinfolist=<xml/>

 

Object containing a list of the content types to be created. After the creation of a content type, the child content types defined will be considered for creation. See the contentTypeInfoList paramater in "Request/Response parameter formats".

Returns

Returns a contenTypeInfoList object containing containing the successfully created content types..

Examples

URL:

http://serverName:serverPort/rest/service/admin/contenttypes?op=create&contenttypeinfolist=

<contentTypeInfoList>
    <contentTypeInfo>
        <name>Pru Child1</name>
        <extensible>true</extensible>
        <parentContentTypeId>10010</parentContentTypeId>
        <contentTypeInfo>
            <name>Child of Project 1</name>
            <extensible>true</extensible>
        </contentTypeInfo>
    </contentTypeInfo>
</contentTypeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contentTypeInfoList>
    <contentTypeInfo id="10011">
        <name>Pru Child1</name>
        <contentTypeHierarchy>System;Asset;Prudencial;Pru Child1;</contentTypeHierarchy>
        <parentContentTypeId>10010</parentContentTypeId>
        <systemDefined>false</systemDefined>
        <childrenAvailable>true</childrenAvailable>
        <extensible>true</extensible>
        <created>2013-11-25T07:21:00Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-11-25T07:21:00Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id </contentTypeAttributeMappingInfo>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="true" attributeId="2">Name </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
    <contentTypeInfo id="10012">
        <name>Child of Project 1</name>
        <contentTypeHierarchy>System;Asset;Prudencial;Pru Child1;Child of Project 1;</contentTypeHierarchy>
        <parentContentTypeId>10011</parentContentTypeId>
        <systemDefined>false</systemDefined>
        <extensible>true</extensible>
        <created>2013-11-25T07:21:00Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-11-25T07:21:00Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id </contentTypeAttributeMappingInfo>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="true" attributeId="2">Name </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>

Example with multiple content types:

URL:

http://serverName:serverPort/rest/service/admin/contenttypes?op=create&contenttypeinfolist=

<contentTypeInfoList>
    <contentTypeInfo>
        <name>Pru 2</name>
        <parentContentTypeId>10010</parentContentTypeId>
        <childrenAvailable>true</childrenAvailable>
        <extensible>true</extensible>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
    <contentTypeInfo>
        <name>Child 1 of Pru 2</name>
        <parentContentTypeId>10011</parentContentTypeId>
        <extensible>true</extensible>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="true" valueMandatory="false" attributeId="509">Master List </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>
<>:

Function

Create content types through content type hierarchy

Description

This request is used to create one or more content types and its child content types according to the specified hierarchy

Type

POST

URL Format

.../admin/contenttypes

Java API

Method Name

Class Name

createContentTypes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

contentTypeInfoList=<xml/>

 

Object containing a list of the content types to be created. After the creation of a content type, the child content types defined will be considered for creation. See the contentTypeInfoList paramater in "Request/Response parameter formats".

Returns

Returns a contentTypeInfoList object containing the successfully created content types.

Examples

URL:

http://serverName:serverPort/rest/service/admin/contenttypes?op=create&contenttypeinfolist=

<contentTypeInfoList>
    <contentTypeInfo>
        <name>Prudencial</name>
        <contentTypeHierarchy>System;Asset;Prudential;</contentTypeHierarchy>
        <extensible>true</extensible>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo valueMandatory="true">Pru_Id</contentTypeAttributeMappingInfo>
            <contentTypeAttributeMappingInfo userMapped="true" valueMandatory="false" attributeId="501">Master Text </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contentTypeInfoList>
    <contentTypeInfo id="10010">
        <name>Prudencial</name>
        <contentTypeHierarchy>System;Asset;Prudencial;</contentTypeHierarchy>
        <parentContentTypeId>1100</parentContentTypeId>
        <systemDefined>false</systemDefined>
        <extensible>true</extensible>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id </contentTypeAttributeMappingInfo>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="true" attributeId="2">Name </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>

getContentType

Function

Get content type.

Description

This request returns complete information on the specified content type. This will also include the child content types.

Type

Get

URL Format

.../admin/contenttypes/{contenttypeIdorName}

Java API

Method Name

Class Name

getContentType

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

contentTypeIdOrName

string

The ID or Name of the content type to be retrieved.

Returns

Returns a contentTypeInfoList object containing information on the specified content type inclusive of its children .

Examples

URL:

http://serverName:serverPort/rest/service/admin/contenttypes/10000

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contentTypeInfoList>
    <contentTypeInfo id="10000">
        <name>Master</name>
        <contentTypeHierarchy>System;Article Component;Picture Component;Master;</contentTypeHierarchy>
        <parentContentTypeId>1300</parentContentTypeId>
        <systemDefined>false</systemDefined>
        <extensible>false</extensible>
        <created>2013-11-22T07:04:29Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-11-22T07:04:29Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id </contentTypeAttributeMappingInfo>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="51">First page </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>

getAllContentTypes

Function

Get all content types.

Description

This request returns complete information of all content types in the system in a hierarchical structure.

Type

GET

URL Format

.../admin/contenttypes

Java API

Method Name

Class Name

getAllContentTypes

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters

Returns

Returns a contenTypeInfoList object containing an array of content types (contentTypeInfo).

Examples

URL:

http://serverName:serverPort/rest/service/admin/contenttypes

Result:

<contentTypeInfoList>
    <contentTypeInfo id="1502">
        <name>Web</name>
        <contentTypeHierarchy>System;Layout;Web;</contentTypeHierarchy>
        <parentContentTypeId>1500</parentContentTypeId>
        <systemDefined>true</systemDefined>
        <extensible>false</extensible>
        <created>2012-04-01T10:00:00Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2012-04-01T10:00:00Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id</contentTypeAttributeMappingInfo>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="43">Number of pages</contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>

updateContentTypes

Function

Update content types.

Description

This request is used to update content types and their children according to the specified id or contentTypeHierarchy.

Type

POST

URL Format

..../admin/contenttypes

Java API

Method Name

Class Name

updateContentTypes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

contenttypeinfolist=<xml/>

 

Object containing a list of the successfully updated content types .

Returns

Returns a contentTypeInfoList object containing a list of all the successfully updated content types..

Examples

URL:

http://serverName:serverPort/rest/service/admin/contenttypes?op=update&contenttypeinfolist=

<contentTypeInfoList>
    <contentTypeInfo id="10015">
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo>
                <attributeName>Id</attributeName>
                <valueMandatory>true</valueMandatory>
            </contentTypeAttributeMappingInfo>
        </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contentTypeInfoList>
    <contentTypeInfo id="10015">
        <name>Prudential</name>
        <contentTypeHierarchy>System;Asset;Prudential;</contentTypeHierarchy>
        <parentContentTypeId>1100</parentContentTypeId>
        <systemDefined>false</systemDefined>
        <childrenAvailable>true</childrenAvailable>
        <extensible>true</extensible>
        <created>2013-11-25T07:35:37Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-11-25T07:35:37Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
    <contentTypeInfo id="10016">
        <name>Pru Nest1</name>
        <contentTypeHierarchy>System;Asset;Prudential;Pru Nest1;</contentTypeHierarchy>
        <parentContentTypeId>10015</parentContentTypeId>
        <systemDefined>false</systemDefined>
        <extensible>true</extensible>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo userMapped="false" valueMandatory="false" attributeId="1">Id </contentTypeAttributeMappingInfo> ........... </contentTypeAttributeMappingInfoList>
    </contentTypeInfo>
</contentTypeInfoList>

Example with multiple content types:

URL:

http://serverName:serverPort/rest/service/admin/users?op=create&userinfolist=

<?xml version="1.0" encoding="UTF-8"?>
<userInfoList>
    <userInfo>
        <name>SampleQPPGroup1</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
    </userInfo>
    <userInfo>
        <name>SampleQPPGroup2</name>
        <nativeTrustee>true</nativeTrustee>
        <enabled>true</enabled>
        <defaultUserClassId>1</defaultUserClassId>
        <defaultUserClass>Administrator</defaultUserClass>
        <ldapProfileId>0</ldapProfileId>
        <deleted>false</deleted>
    </userInfo>
</userInfoList>

Result:

http://serverName:serverPort/rest/service/admin/contenttypes?op=update&contenttypeinfolist=

<contentTypeInfoList>
    <contentTypeInfo>
        <name>project aaa new name</name>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo>
                <attributeName>Master List</attributeName>
                <valueMandatory>true</valueMandatory>
            </contentTypeAttributeMappingInfo>
        </contentTypeAttributeMappingInfoList>
        <contentTypeHierarchy>System;Asset;Prudential;project aaa new name;</contentTypeHierarchy>
    </contentTypeInfo>
    <contentTypeInfo>
        <name>Pru Nest 1</name>
        <contentTypeAttributeMappingInfoList>
            <contentTypeAttributeMappingInfo>
                <attributeName>Master Day</attributeName>
                <valueMandatory>true</valueMandatory>
            </contentTypeAttributeMappingInfo>
        </contentTypeAttributeMappingInfoList>
        <contentTypeHierarchy>System;Asset;Prudential;Pru Nest 1 New Name;</contentTypeHierarchy>
    </contentTypeInfo>
</contentTypeInfoList>

deleteContentType

Function

Delete a content type.

Description

This request is used to delete the specified content type.

Type

POST

URL Format

.../admin/contenttypes/{contenttypeIdorName}

Java API

Method Name

Class Name

deleteContentType

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

contentTypeIdOrName

string

Id or Name of the content type to be deleted.

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

string

Attributes Ids or Names.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/contenttypes/10015?op=delete:

createAttributes

Function

Create Attributes.

Description

This request is used to create a single or multiple attributes at one time.

Type

POST

URL Format

.../admin/attributes

Java API

Method Name

Class Name

createAttributes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

attributeinfolist

string

List of attributes to create.

Returns

Returns a attributeInfoList object containing a list of successfully created attributes.

Examples

URL:

http://serverName:serverPort/rest/service/admin/attributes?op=create&attributeinfolist=

<attributeInfoList>
    <attributeInfo>
        <name>Collections Sequence</name>
        <valueType>TEXT</valueType>
        <queryable>true</queryable>
        <creatorName>Admin</creatorName>
        <displayable>true</displayable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>From Creation to Publishing</defaultValue>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeInfoList>
    <attributeInfo id="519">
        <name>Collections Sequence</name>
        <valueTypeId>1</valueTypeId>
        <valueType>TEXT</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <created>2013-12-05T05:52:57Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-12-05T05:52:57Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>From Creation to Publishing</defaultValue>
            <textSearchEnabled>false</textSearchEnabled>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

Example with multiple attributes:

URL:

http://serverName:serverPort/rest/service/admin/attributes?op=create&attributeinfolist=

<attributeInfoList>
    <attributeInfo>
        <name>Collections Sequence 1</name>
        <valueType>TEXT</valueType>
        <queryable>true</queryable>
        <creatorName>Admin</creatorName>
        <displayable>true</displayable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>From Creation to Publishing</defaultValue>
        </attributeValuePreferenceInfo>
    </attributeInfo>
    <attributeInfo>
        <name>Collections Sequence 2</name>
        <valueType>TEXT</valueType>
        <queryable>true</queryable>
        <creatorName>Admin</creatorName>
        <displayable>true</displayable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>From Creation to Publishing</defaultValue>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeInfoList>
    <attributeInfo id="519">
        <name>Collections Sequence 1</name>
        <valueTypeId>1</valueTypeId>
        <valueType>TEXT</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <created>2013-12-05T05:52:57Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-12-05T05:52:57Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>From Creation to Publishing</defaultValue>
            <textSearchEnabled>false</textSearchEnabled>
        </attributeValuePreferenceInfo>
    </attributeInfo>
    <attributeInfo id="520">
        <name>Collections Sequence 2</name>
        <valueTypeId>1</valueTypeId>
        <valueType>TEXT</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <created>2013-12-05T05:52:57Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-12-05T05:52:57Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>From Creation to Publishing</defaultValue>
            <textSearchEnabled>false</textSearchEnabled>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

setAttributes

Function

Map ContentType with attributes.

Description

This request is used to update the attribute mapping of content types and their children with the specified map of attributes.

Type

POST

URL Format

..../admin/contenttypes

Java API

Method Name

Class Name

setAttributes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=setattributes

string

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

contentTypes= [comma-separated list of Content Types]

string

Content type IDs or Names.

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

string

Attributes IDs or Names.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/contenttypes? op=setattributes&contenttypes=1000&attributes= 180,305:

getAttribute

Function

Get an attribute with a specific ID or Name.

Description

This request returns an attribute with the specified ID or Name.

Type

GET

URL Format

.../admin/attributes/{attributeIdORattributeName}

Java API

Method Name

Class Name

getAttribute

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns an attributeInfoList object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/admin/attributes/collection

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeInfoList>
    <attributeInfo id="55">
        <name>Collection</name>
        <valueTypeId>7</valueTypeId>
        <valueType>DOMAIN</valueType>
        <userDefined>false</userDefined>
        <queryable>false</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>false</limitedAccessChangeable>
        <constraintsChangeable>false</constraintsChangeable>
        <valuePreferencesChangeable>false</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <domainId>19</domainId>
            <domainName>Collections</domainName>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

getAllAttributes

Function

Get all attributes and attribute IDs.

Description

This request returns all existing attributes with their metadata of QPP Server.

Type

GET

URL Format

.../admin/attributes

Java API

Method Name

Class Name

getAllAttributes

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns an attributeInfoList object containing an array of attributes that exist in the QPP server.

Examples

URL:

http://serverName:serverPort/rest/service/admin/attributes

<attributeInfoList>
    <attributeInfo id="180">
        <name>App Studio Issue URN</name> ..... </attributeInfo>
    <attributeInfo id="305">
        <name>Article Component id</name> ..... </attributeInfo> ..... </attributeInfoList>

Result:

An attributeInfoList object containing an array of attributes that exist in the QPP server.

updateAttributes

Function

Update attributes.

Description

This request is used to update the metadata of a single or multiple attributes.

Type

POST

URL Format

.../admin/attributes

Java API

Method Name

Class Name

updateAttributes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

attributeinfolist

string

List of attributes to be updated.

Returns

Returns an attributeInfoList object containing a list of successfully updated attributes.

Examples

URL:

http://serverName:serverPort/rest/service/admin/attributes?op=update&attributevaluelist=

<attributeInfoList>
    <attributeInfo id="507">
        <name>Release Version</name>
        <valueTypeId>5</valueTypeId>
        <valueType>MEASUREMENT</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>4</defaultValue>
            <maximumPossibleValue>7</maximumPossibleValue>
            <minimumPossibleValue>2</minimumPossibleValue>
            <measurementUnit>10</measurementUnit>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeInfoList>
    <attributeInfo id="507">
        <name>Release Version</name>
        <valueTypeId>5</valueTypeId>
        <valueType>MEASUREMENT</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <created>2013-12-05T05:14:07Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-12-05T10:13:29Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>4.0</defaultValue>
            <maximumPossibleValue>7.0</maximumPossibleValue>
            <minimumPossibleValue>2.0</minimumPossibleValue>
            <measurementUnit>10</measurementUnit>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

Example with multiple attributes to update:

URL:

http://serverName:serverPort/rest/service/admin/attributes?op=update&attributevaluelist=

<attributeInfoList>
    <attributeInfo id="502">
        <name>Article Release 1</name>
        <valueTypeId>2</valueTypeId>
        <valueType>DATE</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>2013-12-06</defaultValue>
            <maximumPossibleValue>2013-12-31</maximumPossibleValue>
            <minimumPossibleValue>2013-12-02</minimumPossibleValue>
        </attributeValuePreferenceInfo>
    </attributeInfo>
    <attributeInfo id="503">
        <name>Article Release 2</name>
        <valueTypeId>2</valueTypeId>
        <valueType>DATE</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>2013-12-06</defaultValue>
            <maximumPossibleValue>2013-12-31</maximumPossibleValue>
            <minimumPossibleValue>2013-12-02</minimumPossibleValue>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeInfoList>
    <attributeInfo id="502">
        <name>Article Release 1</name>
        <valueTypeId>2</valueTypeId>
        <valueType>DATE</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <created>2013-12-05T05:11:51Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-12-05T10:17:38Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>2013-12-06</defaultValue>
            <maximumPossibleValue>2013-12-31</maximumPossibleValue>
            <minimumPossibleValue>2013-12-02</minimumPossibleValue>
        </attributeValuePreferenceInfo>
    </attributeInfo>
    <attributeInfo id="503">
        <name>Article Release 2</name>
        <valueTypeId>2</valueTypeId>
        <valueType>DATE</valueType>
        <userDefined>true</userDefined>
        <queryable>true</queryable>
        <modificationLevel>USER_MODIFIABLE</modificationLevel>
        <created>2013-12-05T05:11:51Z</created>
        <creator>1</creator>
        <creatorName>Admin</creatorName>
        <lastModified>2013-12-05T10:17:38Z</lastModified>
        <lastModifier>1</lastModifier>
        <lastModifierName>Admin</lastModifierName>
        <displayable>true</displayable>
        <limitedAccess>false</limitedAccess>
        <limitedAccessChangeable>true</limitedAccessChangeable>
        <constraintsChangeable>true</constraintsChangeable>
        <valuePreferencesChangeable>true</valuePreferencesChangeable>
        <attributeValuePreferenceInfo>
            <defaultValue>2013-12-06</defaultValue>
            <maximumPossibleValue>2013-12-31</maximumPossibleValue>
            <minimumPossibleValue>2013-12-02</minimumPossibleValue>
        </attributeValuePreferenceInfo>
    </attributeInfo>
</attributeInfoList>

deleteAttribute

Function

Delete an Attribute.

Description

This request is used to delete an attribute with the specified id or name.

Type

POST

URL Format

.../admin/attributes/{attributeIdORattributeName}

Java API

Method Name

Class Name

deleteAttribute

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

attributeIdORName

long or string

The Name or ID of the attribute to be deleted.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/attributes/[attributeIdorName]?op=delete

createForms

Function

Create forms.

Description

This request is used to create a new form in the system.

Type

POST

URL Format

..../admin/forms

Java API

Method Name

Class Name

createForms

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

forminfolist

string

List of forms to be created.

Returns

Returns a formInfoList object containing a list of successfully created forms.A status of 200 is returned in response to a successful request execution.

Examples

URL:

http://serverName:serverPort/rest/service/admin/forms?op=create&forminfolist=

<formInfoList>
    <formInfo>
        <contentTypeName>Project</contentTypeName>
        <workflowName>Quark</workflowName>
        <formAttributeList>
            <formAttribute>
                <name>Collection Path</name>
                <xPos>0</xPos>
                <yPos>175</yPos>
                <totalWidth>450</totalWidth>
                <controlWidth>300</controlWidth>
                <labelWidth>150</labelWidth>
                <valueType>1</valueType>
            </formAttribute> ........... </formAttributeList>
    </formInfo>
</formInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<formInfoList>
    <formInfo id="32">
        <contentTypeId>1102</contentTypeId>
        <contentTypeName>Project</contentTypeName>
        <workflowId>10</workflowId>
        <workflowName>Quark</workflowName>
        <defaultView>false</defaultView>
        <formAttributeList>
            <formAttribute id="57">
                <name>Collection Path</name>
                <xPos>0</xPos>
                <yPos>175</yPos>
                <totalWidth>450</totalWidth>
                <controlWidth>300</controlWidth>
                <labelWidth>150</labelWidth>
                <valueType>1</valueType>
            </formAttribute> ........... </formAttributeList>
    </formInfo>
</formInfoList>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<formInfoList>
    <formInfo id="58">
        <contentTypeId>1413</contentTypeId>
        <contentTypeName>Project</contentTypeName>
        <workflowId>0</workflowId>
        <defaultView>false</defaultView>
        <formAttributeList>
            <formAttribute id="57">
                <name>Collection Path</name>
                <xPos>0</xPos>
                <yPos>0</yPos>
                <totalWidth>450</totalWidth>
                <controlWidth>300</controlWidth>
                <labelWidth>150</labelWidth>
                <valueType>1</valueType>
            </formAttribute> ........... </formAttributeList>
    </formInfo> ....... </formInfoList>

getAllForms

Function

Get all forms.

Description

This request is used to get all forms saved in the system.

Type

GET

URL Format

.../admin/forms

Java API

Method Name

Class Name

getAllForms

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters

Returns

Returns a formInfoList object containing a list of all the forms.

Examples

URL:

http://serverName:serverPort/rest/service/admin/forms

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<formInfoList>
    <formInfo id="58">
        <contentTypeId>1413</contentTypeId>
        <contentTypeName>Project</contentTypeName>
        <workflowId>0</workflowId>
        <defaultView>false</defaultView>
        <formAttributeList>
            <formAttribute id="57">
                <name>Collection Path</name>
                <xPos>0</xPos>
                <yPos>0</yPos>
                <totalWidth>450</totalWidth>
                <controlWidth>300</controlWidth>
                <labelWidth>150</labelWidth>
                <valueType>1</valueType>
            </formAttribute> ........... </formAttributeList>
    </formInfo> ....... </formInfoList>

Function

Get forms with a specific workflow

Description

This request returns all forms specific to given workflow.

Type

GET

URL Format

..../admin/forms

Java API

Method Name

Class Name

getAllForms

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

workflow

string

ID or name of the workflow.

Returns

Returns a formInfoList object containing a list of all the forms specific to a given workflow.

Examples

URL:

http://serverName:serverPort/rest/service/admin/forms?workflow=Quark

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<formInfoList>
    <formInfo id="53">
        <contentTypeId>1100</contentTypeId>
        <contentTypeName>Asset</contentTypeName>
        <workflowId>11</workflowId>
        <workflowName>Quark</workflowName>
        <defaultView>false</defaultView>
        <formAttributeList>
            <formAttribute id="34">
                <name>Checkedout Application</name>
                <xPos>0</xPos>
                <yPos>0</yPos>
                <totalWidth>450</totalWidth>
                <controlWidth>314</controlWidth>
                <labelWidth>154</labelWidth>
                <valueType>1</valueType>
            </formAttribute> ........... </formAttributeList>
    </formInfo>
</formInfoList>

Function

Get forms with a specific content type.

Description

This request is used to get all forms specific to a given content type.

Type

GET

URL Format

..../admin/forms

Java API

Method Name

Class Name

getAllForms

com.quark.qpp.service.facade Class AdminFacade

Parameters

 

Name

Type

Description

contenttype

string

ID or name of the content type. Mandatory.

workflow

string

ID of name of the worflow. Mandatory.

Returns

Returns a formInfoList object containing a list of all the forms specific to a given content type.

Examples

URL:

http://serverName:serverPort/rest/service/admin/forms?

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <formInfoList>
    <formInfo id="58">
      <contentTypeId>1413</contentTypeId>
      <contentTypeName>Project</contentTypeName>
      <workflowId>0</workflowId>
      <defaultView>false</defaultView>
        <formAttributeList>
          <formAttribute id="57">
          <name>Collection Path</name>
          <xPos>0</xPos>
          <yPos>0</yPos>
          <totalWidth>450</totalWidth>
          <controlWidth>300</controlWidth>
          <labelWidth>150</labelWidth>
          <valueType>1</valueType>
        </formAttribute>
        ...........
      </formAttributeList>
    </formInfo>
    .......
  </formInfoList>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <formInfoList>
    <formInfo id="54">
      <contentTypeId>1101</contentTypeId>
      <contentTypeName>Document</contentTypeName>
      <workflowId>11</workflowId>
      <workflowName>Quark</workflowName>
      <defaultView>false</defaultView>
      <formAttributeList>
        <formAttribute id="13">
          <name>Is checked out</name>
          <xPos>0</xPos>
          <yPos>184.97</yPos>
          <totalWidth>457</totalWidth>
          <controlWidth>304.66666666666663</controlWidth>
          <labelWidth>154</labelWidth>
          <valueType>6</valueType>
        </formAttribute>
        ...........
      </formAttributeList>
    </formInfo>
  </formInfoList>

updateForms

Function

Update forms.

Description

This request is used to updates metadata of a single or multiple forms at one time.

Type

POST

URL Format

..../admin/forms

Java API

Method Name

Class Name

updateForms

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

forminfolist

string

List of forms to be updated.

Returns

Returns a formInfoList object containing a list of all the forms specific to a given workflow.

Examples

URL:

http://serverName:serverPort/rest/service/admin/forms?op=update&forminfolist=

 <formInfoList>
   <formInfo>
     <contentTypeName>Document</contentTypeName>
     <workflowName>Quark</workflowName>
     <formAttributeList>
       <formAttribute id="13">
         <name>Is checked out</name>
         <xPos>0</xPos>
         <yPos>184.97</yPos>
         <totalWidth>457</totalWidth>
         <controlWidth>304.66666666666663</controlWidth>
          <labelWidth>154</labelWidth>
          <valueType>6</valueType>
        </formAttribute>
      </formAttributeList>
    </formInfo>
  </formInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>  <formInfoList>
   <formInfo id="11">
     <contentTypeId>1101</contentTypeId>
     <contentTypeName>Document</contentTypeName>
     <workflowId>10</workflowId>
     <workflowName>Quark</workflowName>
     <defaultView>false</defaultView>
     <formAttributeList>
       <formAttribute id="13">
         <name>Is checked out</name>
         <xPos>0</xPos>
         <yPos>184.97</yPos>
         <totalWidth>457</totalWidth>
         <controlWidth>304.66666666666663</controlWidth>
         <labelWidth>154</labelWidth>
         <valueType>6</valueType>
       </formAttribute>
     </formAttributeList>
   </formInfo>
 </formInfoList>

Example with multiple forms to update

URL:

http://serverName:serverPort/rest/service/admin/forms?op=update&forminfolist=

  <formInfoList>
    <formInfo id="91">
      <contentTypeId>10004</contentTypeId>
      <contentTypeName>Archive</contentTypeName>
      <workflowId>0</workflowId>
      <defaultView>false</defaultView>
        <formAttributeList>
          <formAttribute id="501">
          <name>Master Text</name>
          <xPos>0</xPos>
          <yPos>263.5</yPos>
          <totalWidth>457</totalWidth>
          <controlWidth>304.66666666666663</controlWidth>
          <labelWidth>154</labelWidth>
          <valueType>1</valueType>
        </formAttribute>
          ...........
        </formAttributeList>
      </formInfo>
      <formInfo id="92">
        <contentTypeId>1403</contentTypeId>
        <contentTypeName>Book</contentTypeName>
        <workflowId>0</workflowId>
        <defaultView>false</defaultView>
        <formAttributeList>
          <formAttribute id="3">
          <name>Created</name>
          <xPos>0</xPos>
          <yPos>60.53</yPos>
          <totalWidth>457</totalWidth>
          <controlWidth>304.66666666666663</controlWidth>
          <labelWidth>154</labelWidth>
          <valueType>8</valueType>
        </formAttribute>
          ...........
      </formAttributeList>
    </formInfo>
  </formInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <formInfoList>
    <formInfo id="91">
    <contentTypeId>10004</contentTypeId>
    <contentTypeName>Archive</contentTypeName>
    <workflowId>0</workflowId>
    <defaultView>false</defaultView>
    <formAttributeList>
       <formAttribute id="501">
       <name>Master Text</name>
       <xPos>0</xPos>
       <yPos>263.5</yPos>
       <totalWidth>457</totalWidth>
       <controlWidth>304.66666666666663</controlWidth>
       <labelWidth>154</labelWidth>
       <valueType>1</valueType>
     </formAttribute>
       ...........
     </formAttributeList>
   </formInfo>
   <formInfo id="92">
     <contentTypeId>1403</contentTypeId>
     <contentTypeName>Book</contentTypeName>
     <workflowId>0</workflowId>
     <defaultView>false</defaultView>
     <formAttributeList>
       <formAttribute id="3">
       <name>Created</name>

deleteForm

Function

Delete a form.

Description

This request is used to delete the specified form.

Type

POST

URL Format

..../admin/forms

Java API

Method Name

Class Name

deleteForm

com.quark.qpp.service.facade Class AdminFacade

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/admin/forms?op=delete&workflow=Quark&contenttype=Document

createRoles

Function

Create roles.

Description

This request is used to create one or more roles/userclass in a single request.

Type

POST

URL Format

.../admin/roles

Java API

Method Name

Class Name

createRoles

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

roleinfolist =<xml/>

 

Object containing a list of the roles to be created. See the roleInfoList paramater in "Request/Response parameter formats".

Returns

Returns a roleInfoList object containing containing a list of the successfully created roles.

Examples

URL:

http://serverName:serverPort/rest/service/admin/roles?op=create&roleinfolist=

<roleInfoList>
    <roleInfo id="11" name="Updated Name of Role">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> .... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ..... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
</roleInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<roleInfoList>
    <roleInfo id="11" name="Updated Name of Role">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> ...... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ...... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
</roleInfoList>

getRole

Function

Get a specific userclass/role.

Description

This request returns the metadata of specified userclass/role.

Type

GET

URL Format

../admin/roles/{roleIdORroleName}

Java API

Method Name

Class Name

getRole

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

roleId

OR

roleName

string

The ID or Name of the role to be retrieved.

Returns

Returns a roleInfoList object in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/admin/roles/Administrator

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<roleInfoList>
    <roleInfo name="Administrator" id="1">
        <applicationPrivList>
            <privilege id="190000016">
                <name>Status Based Routings</name>
            </privilege> ...... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeHierarchy="System;Asset;" contentType="Asset" contentTypeId="1100">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ...... </contentTypePriv>
            <contentTypePriv contentTypeHierarchy="System;Asset;Media;Video;" contentType="Video" contentTypeId="1152">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ..... </contentTypePriv>
        </contentTypePrivList> ...... </roleInfo>
</roleInfoList>

getAllRoles

Function

Get all userclasses/roles.

Description

This request returns all the userclasses with its metadata.

Type

GET

URL Format

../admin/roles

Java API

Method Name

Class Name

getAllRoles

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a roleInfoList object containing an array of all roles that exist on the QPP Server.

Examples

URL:

http://serverName:serverPort/rest/service/admin/roles

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<roleInfoList>
    <roleInfo name="Administrator" id="1"/>
    <roleInfo name="UserClass2" id="10"/>
</roleInfoList>

updateRoles

Function

Update roles.

Description

This request is used to update the metadata of a specified single or multiple roles.

Type

POST

URL Format

..../admin/roles

Java API

Method Name

Class Name

updateRoles

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

roleinfolist=<xml/>

 

Object containing the metadata of the roles to be updated.

Returns

Returns a roleInfoList object containing a list of all the successfully updated roles.

Examples

URL:

http://serverName:serverPort/rest/service/admin/roles?op=update&roleinfolist=

<roleInfoList>
    <roleInfo id="11" name="Updated Name of Role">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> .... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ..... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
</roleInfoList>

Result:

<roleInfoList>
    <roleInfo id="11" name="Updated Name of Role">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> ....... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ...... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
</roleInfoList>

Example with multiple roles

URL:

http://serverName:serverPort/rest/service/admin/roles?op=update&roleinfolist=

<roleInfoList>
    <roleInfo id="11" name="Updated Name of Role 1">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> ...... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ...... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
    <roleInfo id="12" name="Updated Name of Role 2">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> ...... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ...... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
</roleInfoList>

Result:

<roleInfoList>
    <roleInfo id="11" name="Updated Name of Role 1">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> ...... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ...... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
    <roleInfo id="12" name="Updated Name of Role 2">
        <applicationPrivList>
            <privilege id="190000017">
                <name>Remove Link with Collection Template</name>
            </privilege>
            <privilege id="999991">
                <name>Live Preview</name>
            </privilege> ...... </applicationPrivList>
        <contentTypePrivList>
            <contentTypePriv contentTypeId="1100" contentType="Asset" contentTypeHierarchy="System;Asset;">
                <privilege id="10000015">
                    <name>Get Original Assets</name>
                </privilege> ...... </contentTypePriv> ....... </contentTypePrivList>
    </roleInfo>
</roleInfoList>

deleteRole

Function

Delete a role.

Description

This request is used to delete the specified role.

Type

POST

URL Format

.../admin/roles/{roleIdorName}

Java API

Method Name

Class Name

deleteRole

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

roleIdorName

string

Id or Name of the role to be deleted.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/roles/23?op=delete

createRelationType

Function

Create Relation Types.

Description

This request is used to create a single or multiple Relation Types at one time.

Type

POST

URL Format

.../admin/relationtypes

Java API

Method Name

Class Name

createRelationTypes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

relationtypeinfolist

string

List of relation types to create.

Returns

Returns a relationTypeInfoList object containing a list of successfully created relation types.

Examples

URL:

http://serverName:serverPort/rest/service/admin/relationtypes?op=create&relationtypeinfolist=

<relationTypeInfoList>
    <relationTypeInfo>
        <name>Private Relations</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="true" id="508"> Master DT </relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="true" id="509"> Master List </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
</relationTypeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relationTypeInfoList>
    <relationTypeInfo id="1010">
        <name>Private Relations</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="true" id="508"> Master DT </relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="true" id="509"> Master List </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
</relationTypeInfoList>

Example with multiple relation types

URL:

http://serverName:serverPort/rest/service/admin/relationtypes?op=create&relationtypeinfolist=

<relationTypeInfoList>
    <relationTypeInfo>
        <name>InDesign 1</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="false" id="410"> Item Name </relationAttribute>
            <relationAttribute valueMandatory="true" userMapped="false" id="419"> InDesign Object UID </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
    <relationTypeInfo>
        <name>InDesign 2</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="false" id="410"> Item Name </relationAttribute>
            <relationAttribute valueMandatory="true" userMapped="false" id="419"> InDesign Object UID </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
</relationTypeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relationTypeInfoList>
    <relationTypeInfo id="1012">
        <name>InDesign 1</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="true" id="410"> Item Name </relationAttribute>
            <relationAttribute valueMandatory="true" userMapped="true" id="419"> InDesign Object UID </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
    <relationTypeInfo id="1013">
        <name>InDesign 2</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="true" id="410"> Item Name </relationAttribute>
            <relationAttribute valueMandatory="true" userMapped="true" id="419"> InDesign Object UID </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
</relationTypeInfoList>

getRelationType

Function

Get Relation Type.

Description

This request is used to get the metadata of a specified relation type.

Type

GET

URL Format

.../admin/relationtypes/{relationTypeIdOrName}

Java API

Method Name

Class Name

getRelationType

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

relationTypeIdOrName

string

The ID or name of the relation type that is to be retrieved.

Returns

Returns a relationTypeInfoList object containing the metadata of the specified relation type.

Examples

URL:

http://serverName:serverPort/rest/service/admin/relationtypes/1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relationTypeInfoList>
    <relationTypeInfo id="1">
        <name>Primary Attachment</name>
        <systemDefined>true</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="false" id="416"> Article Component Reference Asset Minor version </relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="false" id="415"> Article Component Reference Asset Major Version </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
</relationTypeInfoList>

getAllRelationTypes

Function

Get all relationship types.

Description

This request returns all the relation types with their attributes.

Type

GET

URL Format

.../admin/relationtypes

Java API

Method Name

Class Name

getAllRelationTypes

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a relationTypeInfoList object containing an array of all relation types that exist on the QPP Server.

Examples

URL:

http://serverName:serverPort/rest/service/admin/relationtypes

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relationTypeInfoList>
    <relationTypeInfo id="1">
        <name>Primary Attachment</name>
        <systemDefined>true</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="false" id="416"> Article Component Reference Asset Minor version</relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="false" id="414"> Article Component Reference Asset Id</relationAttribute> ..... </relationAttributeList>
    </relationTypeInfo>
    <relationTypeInfo id="2">
        <name>Secondary Attachment</name>
        <systemDefined>true</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="false" id="415"> Article Component Reference Asset Major Version</relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="false" id="416"> Article Component Reference Asset Minor version</relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="false" id="413"> Article Id</relationAttribute> ....... </relationAttributeList>
    </relationTypeInfo> .... </relationTypeInfoList>

updateRelationTypes

Function

Update relation types.

Description

This request is used to update the metadata of user defined relation types.

Type

POST

URL Format

.../admin/relationtypes

Java API

Method Name

Class Name

updateRelationTypes

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

relationtypeinfolist

string

List of relation types to be updated.

Returns

Returns a relationTypeInfoList object containing a list of successfully updated relation types.

Examples

URL:

http://serverName:serverPort/rest/service/admin/relationtypes?op=update&relationtypeinfolist=

<relationTypeInfoList>
    <relationTypeInfo id="1000">
        <name>Custom Relations Updated</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>false</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="true" id="507"> Release Points </relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="true" id="506"> Release Inches Decimal </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
</relationTypeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relationTypeInfoList>
    <relationTypeInfo id="1000">
        <name>Custom Relations Updated</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>false</checkOutMandatory>
        <relationAttributeList>
            <relationAttribute valueMandatory="false" userMapped="true" id="507"> Release Points </relationAttribute>
            <relationAttribute valueMandatory="false" userMapped="true" id="506"> Release Inches Decimal </relationAttribute> ........... </relationAttributeList>
    </relationTypeInfo>
</relationTypeInfoList>

Example with multiple relation types to update

URL:

http://serverName:serverPort/rest/service/admin/relationtypes?op=update&relationtypeinfolist=

<relationTypeInfoList>
    <relationTypeInfo>
        <name>demo relation 1</name>
        <checkOutMandatory>true</checkOutMandatory>
    </relationTypeInfo>
    <relationTypeInfo>
        <name>demo relation 2</name>
        <checkOutMandatory>true</checkOutMandatory>
    </relationTypeInfo> ........... </relationTypeInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<relationTypeInfoList>
    <relationTypeInfo id="1011">
        <name>demo relation 1</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
    </relationTypeInfo>
    <relationTypeInfo id="1012">
        <name>demo relation 2</name>
        <systemDefined>false</systemDefined>
        <checkOutMandatory>true</checkOutMandatory>
    </relationTypeInfo> ........... </relationTypeInfoList>

deleteRelationType

Function

Delete a Relation Type.

Description

This request is used to delete a relation type with the specified id or name.

Type

POST

URL Format

.../admin/relationtypes/{relationTypeIdOrName}

Java API

Method Name

Class Name

deleteRelationType

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

relationTypeORName

long or string

List of forms to be updated.The Name or ID of the relation type to be deleted.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/relationtypes/1000?op=delete

createDomains

Function

Create Attribute Domains.

Description

This request is used to create a single or multiple attribute domains at one time.

Type

POST

URL Format

.../admin/domains

Java API

Method Name

Class Name

createDomains

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

attributedomaininfolist

string

List of attribute domains to create.

Returns

Returns a attributeDomainInfoList object containing a list of successfully created attribute domains.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains?op=create&attributedomaininfolist=

<attributeDomainInfoList>
    <attributeDomainInfo>
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId>
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeDomainInfoList>
    <attributeDomainInfo id="504">
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

Example with multiple domains

URL:

http://serverName:serverPort/rest/service/admin/domains?op=create&attributedomaininfolist=

<attributeDomainInfoList>
    <attributeDomainInfo>
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId>
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
    <attributeDomainInfo>
        <name>Domain 2</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>true</warnBeforeExpansion>
        <domainValueList>
            <nameId>
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeDomainInfoList>
    <attributeDomainInfo id="502">
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
    <attributeDomainInfo id="503">
        <name>Domain 2</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>true</warnBeforeExpansion>
        <domainValueList>
            <nameId id="2">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

getDomain

Function

Get Attribute Domain.

Description

This request is used to get the metadata of a specified attribute domain.

Type

GET

URL Format

....admin/domains/{domainIdOrName}

Java API

Method Name

Class Name

getDomain

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

domainTypeIdOrName

string

The ID or name of the domain that is to be retrieved.

Returns

Returns an attributeDomainInfoList object containing the metadata of the specified domain.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/3

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeDomainInfoList>
    <attributeDomainInfo id="3">
        <name>Users</name>
        <systemDefined>true</systemDefined>
        <userModifiable>false</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>false</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Admin</name>
            </nameId>
            <valueHierarchy>Desktop</valueHierarchy> ........... </domainValueList>
    </attributeDomainInfo> ....... </attributeDomainInfoList>

getAllDomains

Function

Get all attribute domains.

Description

This request is used to get the metadata of all the domains that exist in the system.

Type

GET

URL Format

.../admin/domains

Java API

Method Name

Class Name

getAllDomains

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns an attributeDomainInfoList object containing the metadata of the all the attribute domains.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeDomainInfoList>
    <attributeDomainInfo id="3">
        <name>Users</name>
        <systemDefined>true</systemDefined>
        <userModifiable>false</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>false</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Admin</name>
            </nameId>
            <valueHierarchy>Desktop</valueHierarchy> ........... </domainValueList>
    </attributeDomainInfo> ....... </attributeDomainInfoList>

updateDomains

Function

Update attribute domains.

Description

This request is used to update the metadata of a single or multiple attribute domains.

Type

POST

URL Format

.../admin/domains

Java API

Method Name

Class Name

updateDomains

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

attributedomaininfolist

string

List of domains to be updated.

Returns

Returns an attributeDomainInfoList object containing a list of successfully updated domains.

Examples

URL:

<attributeDomainInfoList>
    <attributeDomainInfo id="503">
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>false</itemsSorted>
        <expandable>false</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeDomainInfoList>
    <attributeDomainInfo id="503">
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>false</itemsSorted>
        <expandable>false</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

Example with multiple attribute domains to update

URL:

http://serverName:serverPort/rest/service/admin/domains?op=update&attributedomaininfolist=

<attributeDomainInfoList>
    <attributeDomainInfo id="502">
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
    <attributeDomainInfo id="503">
        <name>Domain 2</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>true</warnBeforeExpansion>
        <domainValueList>
            <nameId id="2">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attributeDomainInfoList>
    <attributeDomainInfo id="502">
        <name>Domain 1</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>false</warnBeforeExpansion>
        <domainValueList>
            <nameId id="1">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
    <attributeDomainInfo id="503">
        <name>Domain 2</name>
        <systemDefined>false</systemDefined>
        <userModifiable>true</userModifiable>
        <itemsSorted>true</itemsSorted>
        <expandable>true</expandable>
        <warnBeforeExpansion>true</warnBeforeExpansion>
        <domainValueList>
            <nameId id="2">
                <name>Value 1</name>
            </nameId>
        </domainValueList>
    </attributeDomainInfo>
</attributeDomainInfoList>

deleteDomain

Function

Delete an Attribute Domain.

Description

This request is used to delete an attribute domain with the specified id or name.

Type

POST

URL Format

..../admin/domains/{domainIdorName}

Java API

Method Name

Class Name

deleteDomain

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

domainIdORName

long or string

The Name or ID of the domain to be deleted.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/503?op=delete

createLdapProfiles

Function

Create LDAP profiles.

Description

This request is used to create one or more LDAP profiles.

Type

POST

URL Format

.../admin/ldapprofiles

Java API

Method Name

Class Name

createLdapProfiles

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

ldapprofileinfolist =<xml/>

 

Object containing a list of the LDAP profiles to be created.

Returns

Returns a ldapProfileInfoList object containing containing the successfully created LDAp profiles.

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapprofiles?op=create&ldapprofileinfolist= <?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ldapProfileInfoList>
    <ldapProfileInfo>
        <name>QPP LDAP Profile</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo>
</ldapProfileInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ldapProfileInfoList>
    <ldapProfileInfo id="10">
        <name>QPP LDAP Profile</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo>
</ldapProfileInfoList>

Example with multiple LDAP profiles

URL: 

http://serverName:serverPort/rest/service/admin/ldapprofiles?op=create&ldapprofileinfolist= <ldapProfileInfoList> <?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ldapProfileInfoList>
    <ldapProfileInfo>
        <name>QPP LDAP Profile India</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo>
    <ldapProfileInfo>
        <name>QPP LDAP Profile US</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo>
</ldapProfileInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ldapProfileInfoList>
    <ldapProfileInfo id="10">
        <name>QPP LDAP Profile India</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo>
    <ldapProfileInfo id="11">
        <name>QPP LDAP Profile US</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo>
</ldapProfileInfoList>

getLdapProfile

Function

Get an LDAP profile.

Description

This request returns the metadata of a specified LDAP profile.

Type

Get

URL Format

.../admin/ldapprofiles/{ldapProfileIdOrName}

Java API

Method Name

Class Name

getLdapProfile

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

ldapProfileIdOrName

string

The ID or Name of the LDAP profile to be retrieved.

Returns

Returns a ldapProfileInfoList object containing information on the specified LDAP profile.

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapprofiles/10

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ldapProfileInfoList>
    <ldapProfileInfo id="10">
        <name>QPP LDAP Profile</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo>
</ldapProfileInfoList>

getAllLdapProfiles

Function

Get all LDAP profiles.

Description

This request returns all the LDAP profiles saved on the system.

Type

GET

URL Format

.../admin/ldapprofiles

Java API

Method Name

Class Name

getAllLdapProfiles

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters

Returns

Returns a ldapProfileInfoList object containing a list of all the LDAP profiles that exist on the QPP Server.

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ldapProfileInfoList>
    <ldapProfileInfo id="10">
        <name>QPP LDAP Profile</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
        <ldapObjectsIdentificationCriteria>
            <userIdentificationCriteria> ... </userIdentificationCriteria>
            <groupIdentificationCriteria> ... </groupIdentificationCriteria>
            <groupMemberAttrName>member</groupMemberAttrName>
            <membershipIdentifyingAttrName>memberof</membershipIdentifyingAttrName>
            <baseDn>BDN</baseDn>
            <filterToGetAllUsersOfGroup> ... </filterToGetAllUsersOfGroup>
            <filterToGetAllSubGroupsOfGroup> ... </filterToGetAllSubGroupsOfGroup>
            <filterToGetAllGroupsOfUser> ... </filterToGetAllGroupsOfUser>
        </ldapObjectsIdentificationCriteria>
        <ldapAttributeInfoList>
            <ldapAttributeInfo id="5">
                <name>USER_EMAIL</name>
                <value>mail</value>
            </ldapAttributeInfo> ......... </ldapAttributeInfoList>
    </ldapProfileInfo> ....... </ldapProfileInfoList>

updateLdapProfiles

Function

Update LDAP profiles.

Description

This request is used to update the metadata of a specified single or multiple LDAP profiles.

Type

POST

URL Format

.../admin/ldapprofiles

Java API

Method Name

Class Name

updateLdapProfiles

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

ldapprofileinfolist=<xml/>

 

Object containing a list of the successfully updated LDAP profiles.

Returns

Returns a ldapProfileInfoList object containing a list of all the successfully updated LDAP profiles.

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows?op=update&workflowinfolist=

<workflowInfoList> <workflowInfo id="22"> <name>DefaultWorkflow New</name> </workflowInfo> </workflowInfoList>

Result: 

http://serverName:serverPort/rest/service/admin/ldapprofiles?op=update&attributevaluelist= 

<?xml version="1.0" encoding="UTF-8" standalone="yes"? >
<ldapProfileInfoList>
    <ldapProfileInfo>
        <name>QPP LDAP Profile India</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
    </ldapProfileInfo>
    <ldapProfileInfo>
        <name>QPP LDAP Profile US</name>
        <realm>INDIA.QUARK.COM</realm>
        <userName>qppadmin@quark.com</userName>
        <authenticationType>KERBEROS</authenticationType>
        <ldapServerInfoList>
            <ldapServerInfo>
                <scheme>LDAP</scheme>
                <serverName>india-dc1.india.quark.com</serverName>
                <port>389</port>
            </ldapServerInfo>
        </ldapServerInfoList>
    </ldapProfileInfo>
</ldapProfileInfoList>

deleteLdapProfile

Function

Delete an LDAP profile.

Description

This request is used to delete the specified LDAP profile from the system. There shouldn't be any LDAP user in the system associated with this profile while executing this request.

Type

POST

URL Format

.../admin/ldapprofiles/{profileId}

Java API

Method Name

Class Name

deleteLdapProfile

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

ldapProfileIdOrName

string

Id or Name of the LDAP profile to be deleted.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapprofiles/10?op=delete

getLdapUsers

Function

Get Ldap users.

Description

This request returns LDAP users using a saved ldap query id/name or a combination of valid ldapprofile id/name, base string & search filter.

Type

GET

URL Format

../admin/ldapusers

Java API

Method Name

Class Name

getLdapUsers

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

savedldapquery

string

Specify the name of the LDAP Query. (Mandatory)

ldapProfile

string

Specify the name of the LDAP profile. (Mandatory)

baseString

string

Specify the base string to fetch LDAP users.(Mandatory)

searchFilter

string

Specify the filter to filter the users. (Mandatory)

defaultUserClass

string

The Quark Publishing Platform Server's UserRole. After fetching users from LDAP Server users will be created with this UserRole. (Mandatory)

pagesize

string

 

Returns

Returns a userInfoList object containing the metadata of the specified users.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users?savedldapquery=LDAP Search&ldapProfile=QPP LDAP Profile&baseString=ou=users,ou=qmhi,dc=india,dc=quark, dc=com&searchFilter=sn=abc&defaultUserClass=UserClass2

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="52">
        <name>abc</name>
        <domainId>0</domainId>
        <user>true</user> ....... <deleted>false</deleted>
        <overriddenUserClassId>0</overriddenUserClassId>
    </userInfo>
    <userInfo id="53">
        <name>abc</name>
        <domainId>0</domainId> ...... </userInfo>
</userInfoList>

importUsersFromLdap

Function

Import users from LDAP using LDAP profile.

Description

This request is used to fetch users metadata from LDAP Server and push it to the Quark Publishing Platform Server.

Type

POST

URL Format

.../admin/users

Java API

Method Name

Class Name

importUsersFromLdap

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=importusers

string

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

ldapProfile

 

Specify the name of the LDAP profile. (Mandatory)

baseString

 

Specify the base string to fetch LDAP users. (Mandatory)

searchFilter

 

Specify the filter to filter the users. (Mandatory)

defaultUserClass

 

The Quark Publishing Platform Server's UserRole. After fetching users from LDAP Server users will be created with this UserRole. (Mandatory)

Returns

Returns a userInfoList object containing metadata of newly fetched\created users in the form of an array.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users?op=importusers &ldapProfile=QPP LDAP Profile&baseString=ou=users,ou=qmhi,dc=india,dc=quark, dc=com&searchFilter=sn=abc&defaultUserClass=UserClass2

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="52">
        <name>abc</name>
        <domainId>0</domainId>
        <user>true</user> ....... <deleted>false</deleted>
        <overriddenUserClassId>0</overriddenUserClassId>
    </userInfo>
    <userInfo id="53">
        <name>abc</name>
        <domainId>0</domainId> ...... </userInfo>
</userInfoList>

Function

Import Users from LDAP using Saved Query

Description

This request is used to fetch users metadata from the LDAP Server and pust it to the Quark Publishing Platform Server.

Type

POST

URL Format

.../admin/users

Java API

Method Name

Class Name

importUsersFromLdap

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=importusers

string

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

savedLdapQuery

 

Specify the name of the saved LDAP Users search. (Mandatory)

Returns

Returns a userInfoList object containing metadata of newly fetched\created users in the form of an array.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users?op=importusers &savedLdapQuery=SavedSearch

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userInfoList>
    <userInfo id="52">
        <name>abc</name>
        <domainId>0</domainId>
        <user>true</user> ....... <deleted>false</deleted>
        <overriddenUserClassId>0</overriddenUserClassId>
    </userInfo>
    <userInfo id="53">
        <name>abc</name>
        <domainId>0</domainId> ...... </userInfo>
</userInfoList>

getLdapGroups

Function

Get LDAP groups.

Description

This request returns LDAP groups using a saved LDAP query or the combination of basestring, ldapprofile and searchfilter.

Type

GET

URL Format

../admin/ldapgroups

Java API

Method Name

Class Name

getLdapGroups

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

savedldapquery=[savedLdapQueryId] or [Name]

long

 

ldapprofile=[ldapProfileId] or [Name]

long

 

basestring= [dc=xyz,dc=abc,dc=com]

long

 

searchfilter

string

 

Returns

Returns a list of LDAP groups on the basis of a saved LDAP query or the combination of LDAP profile, base string and searchfilter.

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapgroups? savedldapquery=MySearch

Result:

<groupInfoList>
    <groupInfo id="0">
        <name>QPP Server</name>
        <emailAddress>QPP Server</emailAddress>
        <nativeTrustee>false</nativeTrustee>
        <defaultUserClassId>0</defaultUserClassId>
        <ldapProfileId>764</ldapProfileId>
        <ldapProfile>QPP LDAP Profile</ldapProfile>
        <ldapDistinguishedName> CN=QPP Server, OU=DistributionLists, OU=QMHI, DC=india, DC=quark, DC=com </ldapDistinguishedName>
        <memberList/>
    </groupInfo>
</groupInfoList>

importGroupsFromLdap

Function

Import LDAP groups.

Description

LDAP groups can be imported into Platform Server along with all of its subgroups and users through the following two options:

Option 1. Using LDAP profile, a base string and search filter to form the LDAP search criteria or 

Option2. On the basis of a saved LDAP query. 

The LDAP groups can be associated with a role by using the defaultuserclass request parameter while importing the groups.  By default, if not mentioned, the Administrator role will be associated to all the imported groups and users.  

Type

POST

URL Format

../admin/groups

Java API

Method Name

Class Name

importGroupsFromLdap

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=importgroups

string

 

 

 

Option 1. 

Mention the following parameters (ldapprofile,basestring,searchfilter) to form LDAP search criteria:-

ldapprofile=[ldapProfileId] or [ldapProfileName]

long

name or id of the LDAP profile

basestring= [dc=xyz,dc=abc,dc=com]

string

base DN under which groups are to be searched.

e.g.  basestring=dc=india,dc=myorg,dc=com

searchfilter= 

string

a string to specify the value of LDAP attributes on whose basis LDAP server will be searched.

e.g. searchfilter=samaccountname=*

searchfilter=cn=qpp*

OR Option2. Mention a saved LDAP query id or name

 

savedldapquery=[savedLdapQueryId]or[savedLdapQueryname]

long/string

name or id of the saved LDAP query from which groups & users are to be imported.

defaultuserclass=[userClassId]or[userClassName]

long/string

Id or name of the role to be associated recursively to the LDAP groups and users that will be imported into Platform Server.

Returns

Returns an importedGroupInfoList object containing a list of LDAP groups on the basis of a saved LDAP query or the combination of LDAP profile, base string and searchfilter.

Examples

URL:

Option 1-Import based on LDAP profile, search filter and base string

 

http://serverName:serverPort/rest/service/admin/groups? op=importgroups&ldapprofile=MyOrgIndia&basestring=dc=india,dc=myorg,dc=com&searchfilter=cn=qpp server

 

Option 2 – Import based on saved LDAP query

http://serverName:serverPort/rest/service/admin/groups? op=importgroups&savedldapquery=SavedSearch_MyOrgGroups

Result:

<importedGroupInfoList>
    <importedGroupInfo>
        <groupInfo id="3681">
            <name>QPP Server</name>
            <emailAddress>QPP Server</emailAddress>
            <defaultUserClass>Administrator<defaultUserClass>
            <nativeTrustee>false</nativeTrustee> ....... </groupInfo>
        <subGroupsInfoList>
            <groupInfo id="3682">
                <name>QPP Server R&amp;D</name> ............ </groupInfo>
        </subGroupsInfoList>
        <userInfoList>
            <userInfo id="3687">
                <name>kshankarraman</name> ....... . </userInfo>
            <userInfo id="3688">
                <name>Menon</name> .......... </userInfo>
        </userInfoList>
    </importedGroupInfo>
</importedGroupInfoList>

 

 

synchronizeLdapUsersGroups

Function

Synchronize all LDAP users and groups.

Description

This request synchronizes all users and groups that were imported from LDAP Server to Platform Server.

Type

GET

URL Format

../admin/ldapprofiles

Java API

Method Name

Class Name

synchronizeLdapUsersGroups

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=synchronize

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.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapprofiles?op=synchronize

synchronizeLdapUsersGroupsBasedOnProfile

Function

Synchronize all LDAP users and groups.

Description

This request synchronizes all users and groups that were imported from LDAP Server to Platform Server using the given LDAP profile..

Type

GET

URL Format

../admin/ldapprofiles/{ldapprofileIdOrName}

Java API

Method Name

Class Name

synchronizeLdapUsersGroupsBasedOnProfile

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=synchronize

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.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapprofiles/Quark India? op=synchronize

createLdapSearches

Function

Create LDAP search definitions.

Description

This request creates creates LDAP search definitions.

Type

POST

URL Format

../admin/ldapsearchdefinitions/

Java API

Method Name

Class Name

createLdapSearches

com.quark.qpp.service.facade Class AdminFacade

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.

ldapsearchinfolist=<xml/>

 

See "Request/Response parameter formats."

Returns

Returns a ldapsearchinfolist object in XML format that contains the metadata of all successfully created LDAP search definitions.

Examples

URL:

https://serverName:serverPort/rest/service/admin/ ldapsearchdefinitions?op=create&ldapsearchinfolist=

<ldapSearchInfoList>
    <ldapSearchInfo>
        <name>Demo groups LDAP search</name>
        <ldapSearchCriteria>
            <ldapProfile>Quark India</ldapProfile>
            <searchFilter>cn=qpp cli*</searchFilter>
            <baseString>dc=india,dc=quark,dc=com</baseString>
            <searchType>GROUPS_SEARCH</searchType>
        </ldapSearchCriteria>
    </ldapSearchInfo>
</ldapSearchInfoList>

Result:

<ldapSearchInfoList>
    <ldapSearchInfo id="123">
        <name>Demo groups LDAP search</name>
        <ldapSearchCriteria>
            <ldapProfile id="18">Quark India</ldapProfile>
            <searchFilter>cn=qpp cli*</searchFilter>
            <baseString>dc=india,dc=quark,dc=com</baseString>
            <searchType>GROUPS_SEARCH</searchType>
        </ldapSearchCriteria>
    </ldapSearchInfo>
</ldapSearchInfoList>

getLdapSearch

Function

Get LDAP search definition.

Description

This request returns the LDAP search definition for the given search id or name.

Type

GET

URL Format

../admin/ldapsearchdefinitions{searchIdOrName}

Java API

Method Name

Class Name

getLdapSearch

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a ldapSearchInfoList object containing the LDAP search definition for the given search id or name.

Examples

URL:

http://serverName:serverPort/rest/service/admin/ ldapsearchdefinitions/MySearch

Result:

<ldapSearchInfoList>
    <ldapSearchInfo id="10">
        <name>MySearch</name>
        <ldapSearchCriteria>
            <ldapProfile id="20">shankar</ldapProfile>
            <searchFilter>sn=*gupta</searchFilter>
            <baseString>dc=quark,dc=com</baseString>
            <searchType id="1">USERS_SEARCH</searchType>
        </ldapSearchCriteria>
    </ldapSearchInfo>
</ldapSearchInfoList>

getAllLdapSearches

Function

Get all saved LDAP search definitions.

Description

This request returns all saved LDAP search definitions.

Type

GET

URL Format

../admin/ldapsearchdefinitions

Java API

Method Name

Class Name

getAllLdapSearches

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a ldapSearchInfoList object containing a list of ldapSearchInfo objects containing the LDAP search definition.

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapsearchdefinitions

Result:

<ldapSearchInfoList>
    <ldapSearchInfo id="438">
        <name>LDAP User Search</name>
        <ldapSearchCriteria>
            <ldapProfile id="764">QPP LDAP Profile</ldapProfile>
            <searchFilter>sn=kumar</searchFilter>
            <baseString>ou=users,ou=qmhi,dc=india,dc=quark,dc=com</baseString>
            <searchType id="1">USERS_SEARCH</searchType>
        </ldapSearchCriteria>
    </ldapSearchInfo>
    <ldapSearchInfo id="439">
        <name>LDAP Group Search</name>
        <ldapSearchCriteria>
            <ldapProfile id="764">QPP LDAP Profile</ldapProfile>
            <searchFilter>cn=qppserver</searchFilter>
            <baseString>dc=india,dc=quark,dc=com</baseString>
            <searchType id="2">GROUPS_SEARCH</searchType>
        </ldapSearchCriteria>
    </ldapSearchInfo>
</ldapSearchInfoList>

updateLdapSearches

Function

Update LDAP search definitions.

Description

This request update the given LDAP search definitions.

Type

POST

URL Format

../admin/ldapsearchdefinitions/

Java API

Method Name

Class Name

uodateLdapSearches

com.quark.qpp.service.facade Class AdminFacade

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.

ldapsearchinfolist=<xml/>

 

See "Request/Response parameter formats."

Returns

Returns a ldapsearchinfolist object in XML format that contains the metadata of all successfully updated LDAP search definitions.

Examples

URL:

https://serverName:serverPort/rest/service/admin/ ldapsearchdefinitions?op=update&ldapsearchinfolist=

<ldapSearchInfoList>
    <ldapSearchInfo>
        <name>Demo groups LDAP search</name>
        <ldapSearchCriteria>
            <ldapProfile>Quark India</ldapProfile>
            <searchFilter>cn=qpp cli*</searchFilter>
            <baseString>dc=india,dc=quark,dc=com</baseString>
            <searchType>GROUPS_SEARCH</searchType>
        </ldapSearchCriteria>
    </ldapSearchInfo>
</ldapSearchInfoList>

Result:

<ldapSearchInfoList>
    <ldapSearchInfo id="123">
        <name>Demo groups LDAP search</name>
        <ldapSearchCriteria>
            <ldapProfile id="10">Quark India</ldapProfile>
            <searchFilter>cn=qpp cli*</searchFilter>
            <baseString>dc=india,dc=quark,dc=com</baseString>
            <searchType id="2">GROUPS_SEARCH</searchType>
        </ldapSearchCriteria>
    </ldapSearchInfo>
</ldapSearchInfoList>

deleteLdapSearch

Function

Delete an LDAP search definition.

Description

This request deletes the given LDAP search definition with the given ID or name.

Type

POST

URL Format

../admin/ldapsearchdefinitions/{searchIdOrName}

Java API

Method Name

Class Name

deleteLdapSearch

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

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.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/ldapsearchdefinitions/ MySearch?op=delete

getTrustee

Function

Get a trustee (a user or group) with a particular name.

Description

This request returns all the metadata of a specified trustee.

Type

GET

URL Format

.../admin/trustees/[trustee name]

Java API

Method Name

Class Name

getTrustee

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a trusteeInfo object in XML format of specified user or group.

Examples

URL:

http://serverName:serverPort/rest/service/admin/trustees/Admin

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<trusteeInfo id="1">
    <user>true</user>
    <deleted>false</deleted>
    <name>Admin</name>
    <emailAddress>Editors@company.com</emailAddress>
    <nativeTrustee>false</nativeTrustee>
    <defaultUserClassId>2</defaultUserClassId>
    <ldapProfileId>10</ldapProfileId>
    <ldapDistinguishedName>Dist Name</ldapDistinguishedName>
    <domainId>0</domainId>
</trusteeInfo>

updateTrusteeRule

Function

Update role for the given trustee.

Description

This request sets the default role for the given trustee (User or Group).

Type

POST

URL Format

.../admin/trustees/{trusteeIdOrName}

Java API

Method Name

Class Name

updateTrusteeRole

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=setrole

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.

role=[RoldId] or [Name]

string

 

overrideuserclass= [True] or [False]

boolean

This flag is applicable only if the trustee Id provided is that of a group. If true, it will override the userclass of all users belonging to the given group.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/trustees/ John?op=setrole&role=Publishers

createWorkflows

Function

Create workflows.

Description

This request is used to create one or more workflows and their statuses.

Type

POST

URL Format

.../admin/workflows

Java API

Method Name

Class Name

createWorkFlows

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

workflowinfolist =<xml/>

 

Object containing a list of the workflows to be created. See the workflowInfoList paramater in "Request/Response parameter formats".

Returns

Returns a workflowInfoList object containing containing the successfully created workflows.

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows?op=create&workflowinfolist=

<workflowInfoList>
    <workflowInfo>
        <name>Publsihing Workflow</name>
        <statusInfoList>
            <statusInfo>
                <name>New Status 001</name>
                <colorBlue>255</colorBlue>
                <position>1</position>
                <redlineTracking>false</redlineTracking>
                <checkInLayoutEvaluation>false</checkInLayoutEvaluation>
                <outputLayoutEvaluation>false</outputLayoutEvaluation>
                <privilegeInfoList>
                    <privilegeInfo>
                        <roleName>Administrator</roleName>
                        <roleId>1</roleId>
                        <overridden>false</overridden>
                        <contentTypePrivList/>
                    </privilegeInfo>
                </privilegeInfoList>
                <attributeConstraintsInfoList>
                    <attributeConstraintsInfo>
                        <attributeName>Name</attributeName>
                        <roleName>Administrator</roleName>
                        <constraintName>PREVENT CHANGE</constraintName>
                    </attributeConstraintsInfo>
                </attributeConstraintsInfoList>
            </statusInfo>
        </statusInfoList>
        <contentTypeInfoList>
            <contentTypeInfo>
                <name>Asset</name>
            </contentTypeInfo>
            <contentTypeInfo id="1102"/>
        </contentTypeInfoList>
    </workflowInfo>
</workflowInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowInfoList>
    <workflowInfo id="20">
        <name>Publishing Workflow</name>
        <domainId>18</domainId>
        <created>2013-11-28T08:58:00Z</created>
        <createdBy>1</createdBy>
        <creatorName>Admin</creatorName>
        <lastModifiedBy>1</lastModifiedBy>
        <lastModifierName>Admin</lastModifierName>
        <lastModified>2013-11-28T08:58:00Z</lastModified>
        <statusInfoList>
            <statusInfo id="20">
                <name>New Status 001</name>
                <domainId>6</domainId>
                <colorRed>0</colorRed>
                <colorGreen>0</colorGreen>
                <colorBlue>255</colorBlue>
                <position>1</position>
                <redlineTracking>false</redlineTracking>
                <checkInLayoutEvaluation>false</checkInLayoutEvaluation>
                <outputLayoutEvaluation>false</outputLayoutEvaluation>
                <privilegeInfoList>
                    <privilegeInfo>
                        <roleName>Administrator</roleName>
                        <roleId>1</roleId>
                        <overridden>false</overridden>
                        <contentTypePrivList/>
                    </privilegeInfo>
                </privilegeInfoList>
                <attributeConstraintsInfoList>
                    <attributeConstraintsInfo>
                        <attributeId>2</attributeId>
                        <attributeName>Name</attributeName>
                        <roleId>1</roleId>
                        <roleName>Administrator</roleName>
                        <constraintId>1</constraintId>
                        <constraintName>PREVENT CHANGE</constraintName>
                    </attributeConstraintsInfo>
                </attributeConstraintsInfoList>
            </statusInfo>
        </statusInfoList>
        <contentTypeInfoList>
            <contentTypeInfo id="1102">
                <name>Project</name>
                <contentTypeHierarchy>System;Asset;Project;</contentTypeHierarchy>
                <domainId>0</domainId>
                <systemDefined>true</systemDefined>
                <childrenAvailable>true</childrenAvailable>
                <extensible>true</extensible>
            </contentTypeInfo>
        </contentTypeInfoList>
    </workflowInfo>
</workflowInfoList>

getWorkflow

Function

Get a workflow with a particular ID or name.

Description

This request returns all the metadata of a specified workflow.

Type

GET

URL Format

.../admin/workflows/[workflow name]

Java API

Method Name

Class Name

getWorkflow

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a workflowInfoList object with the metadata of a specified workflow in XML format.

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows/workflow1

Result:

<workflowInfoList>
    <workflowInfo id="10">
        <name>Workflow1</name>
        <domainId>18</domainId>
        <created>2013-12-23T12:06:33Z</created>
        <createdBy>1</createdBy>
        <creatorName>Admin</creatorName>
        <lastModifiedBy>1</lastModifiedBy>
        <lastModifierName>Admin</lastModifierName>
        <lastModified>2013-12-23T12:06:33Z</lastModified>
        <statusInfoList>
            <statusInfo id="10">
                <name>Status1</name>
                <domainId>6</domainId>
                <colorRed>50</colorRed>
                <colorGreen>150</colorGreen>
                <colorBlue>10</colorBlue>
                <position>1</position>
                <redlineTracking>false</redlineTracking>
                <checkInLayoutEvaluation>false</checkInLayoutEvaluation>
                <outputLayoutEvaluation>false</outputLayoutEvaluation>
                <privilegeInfoList>
                    <privilegeInfo>
                        <roleName>Administrator</roleName>
                        <roleId>1</roleId>
                        <overridden>false</overridden>
                        <contentTypePrivList/>
                    </privilegeInfo>
                    <privilegeInfo>
                        <roleName>UserClass2</roleName>
                        <roleId>10</roleId>
                        <overridden>false</overridden>
                        <contentTypePrivList/>
                    </privilegeInfo>
                </privilegeInfoList>
                <attributeConstraintsInfoList/>
            </statusInfo> ..... </statusInfoList>
        <contentTypeInfoList>
            <contentTypeInfo id="1100">
                <name>Asset</name>
                <contentTypeHierarchy>System;Asset;</contentTypeHierarchy>
                <domainId>0</domainId>
                <systemDefined>true</systemDefined>
                <childrenAvailable>true</childrenAvailable>
                <extensible>true</extensible>
            </contentTypeInfo> ...... </contentTypeInfoList>
    </workflowInfo>
</workflowInfoList>

Function

Get a workflow

Description

This request returns the metadata and status of a specified workflow.

Type

Get

URL Format

..../admin/workflows/{workflowIdorName}

Java API

Method Name

Class Name

getWorkflow

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

workflowIdOrName

string

The ID or Name of the workflow to be retrieved.

Returns

Returns a workflowInfoList object containing information on the specified workflow.

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows/21

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowInfoList>
    <workflowInfo id="21">
        <name>New Workflow</name>
        <domainId>18</domainId>
        <created>2013-12-09T11:45:42Z</created>
        <createdBy>1</createdBy>
        <creatorName>Admin</creatorName>
        <lastModifiedBy>1</lastModifiedBy>
        <lastModifierName>Admin</lastModifierName>
        <lastModified>2013-12-09T11:45:42Z</lastModified>
        <statusInfoList>
            <statusInfo id="24">
                <name>New Status 001</name>
                <domainId>6</domainId>
                <colorRed>0</colorRed>
                <colorGreen>0</colorGreen>
                <colorBlue>255</colorBlue>
                <position>1</position>
                <redlineTracking>false</redlineTracking>
                <checkInLayoutEvaluation>false</checkInLayoutEvaluation>
                <outputLayoutEvaluation>false</outputLayoutEvaluation>
                <privilegeInfoList>
                    <privilegeInfo>
                        <roleName>Administrator</roleName>
                        <roleId>1</roleId>
                        <overridden>false</overridden>
                        <contentTypePrivList/>
                    </privilegeInfo> ......... </privilegeInfoList>
                <attributeConstraintsInfoList>
                    <attributeConstraintsInfo>
                        <attributeId>2</attributeId>
                        <attributeName>Name</attributeName>
                        <roleId>1</roleId>
                        <roleName>Administrator</roleName>
                        <constraintId>1</constraintId>
                        <constraintName>PREVENT CHANGE</constraintName>
                    </attributeConstraintsInfo>
                </attributeConstraintsInfoList>
            </statusInfo>
        </statusInfoList>
        <contentTypeInfoList>
            <contentTypeInfo id="1100">
                <name>Asset</name>
                <contentTypeHierarchy>System;Asset;</contentTypeHierarchy>
                <domainId>0</domainId>
                <systemDefined>true</systemDefined>
                <childrenAvailable>true</childrenAvailable>
                <extensible>true</extensible>
            </contentTypeInfo> ......... </contentTypeInfoList>
    </workflowInfo>
</workflowInfoList>

getAllWorkflows

Function

Get all workflows.

Description

This request returns all the metadata of all the workflows that exist on the QPP Server.

Type

GET

URL Format

.../admin/workflows

Java API

Method Name

Class Name

getAllWorkflows

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a workflowInfoList object containing an array of all the workflows that exist on the QPP Server.

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowInfoList>
    <workflowInfo id="10">
        <name>Workflow1</name> .... <statusInfoList>
            <statusInfo id="10">
                <name>Status1</name> .... </statusInfo>
            <statusInfo id="11">
                <name>Status2</name> .... </statusInfo>
        </statusInfoList>
    </workflowInfo>
    <workflowInfo id="11">
        <name>Workflow2</name> .... <statusInfoList>
            <statusInfo id="12">
                <name>Status1</name> .... </statusInfo>
            <statusInfo id="13">
                <name>Status2</name> .... </statusInfo>
        </statusInfoList>
    </workflowInfo>
</workflowInfoList>

updateWorkflows

Function

Update workflows.

Description

This request is used to update the metadata of a specified single or multiple workflows and their statuses.

Type

POST

URL Format

..../admin/workflows

Java API

Method Name

Class Name

updateWorkflows

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

workflowinfolist=<xml/>

 

Object containing a list of the successfully updated workflows .

Returns

Returns a workflowInfoList object containing a list of all the successfully updated workflows.

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows?op=update&workflowinfolist=

<workflowInfoList>
    <workflowInfo id="22">
        <name>DefaultWorkflow New</name>
    </workflowInfo>
</workflowInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowInfoList>
    <workflowInfo id="22">
        <name>DefaultWorkflow New</name>
        <domainId>18</domainId>
        <created>2013-11-28T09:01:38Z</created>
        <createdBy>1</createdBy>
        <creatorName>Admin</creatorName>
        <lastModifiedBy>1</lastModifiedBy>
        <lastModifierName>Admin</lastModifierName>
        <lastModified>2013-11-28T09:03:26Z</lastModified>
        <statusInfoList/>
        <contentTypeInfoList>
            <contentTypeInfo id="1100">
                <name>Asset</name>
                <contentTypeHierarchy>System;Asset;</contentTypeHierarchy>
                <domainId>0</domainId>
                <systemDefined>true</systemDefined>
                <childrenAvailable>true</childrenAvailable>
                <extensible>true</extensible>
            </contentTypeInfo> ......... </contentTypeInfoList>
    </workflowInfo>
</workflowInfoList>

deleteWorkFlow

Function

Delete a workflow.

Description

This request is used to delete the specified workflow.

Type

POST

URL Format

.../admin/workflows/{workflowIdorName}

Java API

Method Name

Class Name

deleteWorkFlow

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=delete

string

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

workflowIdOrName

string

ID or Name of the workflow to be deleted.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/workflows/22?op=delete

createPreferences

Function

Create Preferences.

Description

This request is used to create a single or multiple preferences at one time.

Type

POST

URL Format

.../admin/preferences

Java API

Method Name

Class Name

createPreferences

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

preferenceinfolist

string

List of preferences to create.

Returns

Returns a preferenceInfoList object containing a list of successfully created preferences.

Examples

URL:

http://serverName:serverPort/rest/service/admin/preferences?op=create&preferenceinfolist=<xml/>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferenceInfoList>
    <preferenceInfo id="10005">
        <name>Demo user preference 3</name>
        <category id="1">USER</category>
        <possibleValuesExist>false</possibleValuesExist>
        <defaultValue>Ths is the default value.</defaultValue>
        <systemDefined>false</systemDefined>
    </preferenceInfo>
    <preferenceInfo id="10006">
        <name>Demo preference without possible values</name>
        <category id="0">SYSTEM</category>
        <possibleValuesExist>false</possibleValuesExist>
        <defaultValue>This is the default new value.</defaultValue>
        <systemDefined>false</systemDefined>
    </preferenceInfo>
</preferenceInfoList>

getPreference

Function

Get a specific preference.

Description

This request returns the metadata of a specified preference.

Type

GET

URL Format

../admin/preferences/{preferenceIdOrName}

Java API

Method Name

Class Name

getPreference

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

preferenceIdOrName

string

The ID or Name of the preference to be retrieved.

Returns

Returns a preferenceInfoList object containing the metadata of the specified preference.

Examples

URL:

http://serverName:serverPort/rest/service/admin/preferences/Content Display View

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferenceInfoList>
    <preferenceInfo id="2006">
        <name>Content Display View</name>
        <category id="1">USER</category>
        <possibleValuesExist>true</possibleValuesExist>
        <defaultValue id="1">Keep Last Setting</defaultValue>
        <preferenceValueList>
            <preferenceValue valueId="1" preferenceName="Content Display View" preferenceId="2006">Keep Last Setting</preferenceValue>
            <preferenceValue valueId="2" preferenceName="Content Display View" preferenceId="2006">WYSIWYG</preferenceValue>
            <preferenceValue valueId="3" preferenceName="Content Display View" preferenceId="2006">Galley</preferenceValue>
            <preferenceValue valueId="4" preferenceName="Content Display View" preferenceId="2006">Full Screen</preferenceValue>
        </preferenceValueList>
        <systemDefined>true</systemDefined>
    </preferenceInfo>
</preferenceInfoList>

getAllPreferences

Function

Get all Preferences.

Description

This request returns all of the existing preference definitions.

Type

GET

URL Format

../admin/preferences

Java API

Method Name

Class Name

getAllPreferences

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a preferenceInfoList object containing metadata of all existing preferences with its possible values.

Examples

URL:

http://serverName:serverPort/rest/service/admin/preferences

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferenceInfoList>
    <preferenceInfo id="1007">
        <name>Display all Redline Deletions in One Color</name>
        <category id="0">SYSTEM</category>
        <possibleValuesExist>false</possibleValuesExist>
        <defaultValue>No</defaultValue>
        <systemDefined>true</systemDefined>
    </preferenceInfo>
    <preferenceInfo id="1008">
        <name>Redline Deletion Color</name>
        <category id="0">SYSTEM</category>
        <possibleValuesExist>false</possibleValuesExist>
        <defaultValue>255,0,0</defaultValue>
        <systemDefined>true</systemDefined>
    </preferenceInfo> .... </preferenceInfoList>

getPreferenceValues

Function

Get Preference values.

Description

This request is used to get preference values for a given preference corresponding to the logged-in user.

Type

GET

URL Format

....admin/preferencevalues

Java API

Method Name

Class Name

getPreferenceValues

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

preferences

string

Comma separated list of Ids or Names of Preferences to be retrieved.

Returns

Returns an preferenceValueList object containing the values set for given preferences for the logged-in user.

Examples

URL:

http://serverName:serverPort/rest/service/admin/preferencevalues?preferences=3018, 1007, 3011, Archive Revisions

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferenceValueList>
    <preferenceValue preferenceName="Display all Redline Deletions in One Color" preferenceId="1007">No</preferenceValue>
    <preferenceValue valueId="1" preferenceName="Default Action for Double Click on Quark XPress Projects" preferenceId="3011">Do Check Out</preferenceValue>
    <preferenceValue valueId="3" preferenceName="Delete Attached Files" preferenceId="3018">Ask Before Deleting</preferenceValue>
    <preferenceValue valueId="3" preferenceName="Archive Revisions" preferenceId="4018">Ask</preferenceValue>
</preferenceValueList>

updatePreferences

Function

Update Preferences.

Description

This request is used to update the metadata of a specified single or multiple preferences.

Type

POST

URL Format

..../admin/preferences

Java API

Method Name

Class Name

updatePreferences

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

preferenceinfolist=<xml/>

 

Object containing the metadata of the preferences to be updated.

Returns

Returns a preferenceInfoList object containing a list of all the successfully updated preferences.

Examples

URL:

http://serverName:serverPort/rest/service/admin/preferences?op=update&preferenceinfolist=<xml/>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferenceInfoList>
    <preferenceInfo id="10005">
        <name>Demo user preference 3</name>
        <category id="1">USER</category>
        <possibleValuesExist>false</possibleValuesExist>
        <defaultValue>Ths is the default value.</defaultValue>
        <systemDefined>false</systemDefined>
    </preferenceInfo>
    <preferenceInfo id="10006">
        <name>Demo preference without possible values</name>
        <category id="0">SYSTEM</category>
        <possibleValuesExist>false</possibleValuesExist>
        <defaultValue>This is the default new value.</defaultValue>
        <systemDefined>false</systemDefined>
    </preferenceInfo>
</preferenceInfoList>

updatePreferenceValues

Function

Update Preference Values.

Description

This request updates the preference values corresponding to the logged-in user.

Type

POST

URL Format

.../preferenceValues

Java API

Method Name

Class Name

updatePreferenceValues

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

long

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

preferencevaluelist=[xml]

string

Object containing the metadata of the preference valuess to be updated.

Returns

Returns a preferencevaluelist object containing the preferences values successfully updated.

Examples

URL:

http://serverName:serverPort/rest/service/admin/preferencevalues?op=update&preferencevaluelist=<xml/>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<preferenceValueList>
    <preferenceValue valueId="1" preferenceName="user 1" preferenceId="10061">system value 2</preferenceValue>
    <preferenceValue valueId="2" preferenceName="user 2" preferenceId="10062">system value 3</preferenceValue>
</preferenceValueList>

deletePreference

Function

Delete a preference.

Description

This request is used to delete the specified preference.

Type

POST

URL Format

.../admin/preferences/{preferenceIdorName}

Java API

Method Name

Class Name

deletePreference

com.quark.qpp.service.facade Class AdminFacade

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/admin/preference/{preferenceIdOrName}?op=delete

createRepositories

Function

Create one or more storage repositories.

Description

This request is used to create new storage repositories.

Type

POST

URL Format

.../admin/repositories

Java API

Method Name

Class Name

createRepositories

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

storagerepositoryinfolist

string

List of storage repositories to create.

Returns

Returns a storageRepositoryInfoList object containing a list of successfully created repositories.

Examples

URL:

http://serverName:serverPort/rest/service/admin/repositories?op=create&storagerepositoryinfolist=

<storageRepositoryInfoList>
    <storageRepositoryInfo>
        <name>PlatformRepository</name>
        <connectionInfo><![CDATA[<connectionProperties><property name='url' required='true'>C:\PlatformRepo</property></connectionProperties>]]></connectionInfo>
        <repositoryType>fileRepositoryAdapter</repositoryType>
    </storageRepositoryInfo>
</storageRepositoryInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><storageRepositoryInfoList>
  <storageRepositoryInfo id="20">
    <name>PlatformRepository</name>
    <connectionInfo>&lt;connectionProperties&gt;&lt;property
     name='url' required='true'&gt;C:\PlatformRepo&lt;
     /property&gt;&lt; /connectionProperties&gt;
    </connectionInfo>
    <repositoryType>fileRepositoryAdapter</repositoryType>
    <repositoryTypeId>1</repositoryTypeId>
    <status>READ_WRITE</status>
     <statusId>1</statusId>
  </storageRepositoryInfo>
</storageRepositoryInfoList>

getRepository

Function

Get a specific repository.

Description

This request returns a storage repository with the given Id or Name.

Type

GET

URL Format

../admin/repositories/{repositoryIdOrName}

Java API

Method Name

Class Name

getRepository

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

repositoryIdOrName

string

The ID or Name of the repository to be retrieved.

Returns

Returns a repositoryInfoList object containing the metadata of the specified repository.

Examples

URL:

http://serverName:serverPort/rest/service/admin/repositories/1

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<storageRepositoryInfoList>
    <storageRepositoryInfo id="1">
        <name>TestRep1</name>
        <connectionInfo>&lt;connectionProperties&gt;&lt;property name='url' required='true'&gt; C:\TestRep1&lt;/property&gt;&lt;/connectionProperties&gt;</connectionInfo>
        <repositoryType>fileRepositoryAdapter</repositoryType>
        <repositoryTypeId>1</repositoryTypeId>
        <status>READ_WRITE</status>
        <statusId>1</statusId>
    </storageRepositoryInfo>
    <storageRepositoryInfo id="10">
        <name>TestRepA</name>
        <connectionInfo>&lt;connectionProperties&gt;&lt;property name='url' required='true'&gt; C:\TestRepA&lt;/property&gt;&lt;/connectionProperties&gt;</connectionInfo>
        <repositoryType>fileRepositoryAdapter</repositoryType>
        <repositoryTypeId>1</repositoryTypeId>
        <status>READ_WRITE</status>
        <statusId>1</statusId>
    </storageRepositoryInfo>
</storageRepositoryInfoList>

getAllRepositories

Function

Get all storage repositories.

Description

This request returns all the information regarding all repositories registered with the platform.

Type

GET

URL Format

../admin/repositories

Java API

Method Name

Class Name

getAllRepositories

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a storageRepositoryInfoList object containing a list of all the registered repositories.

Examples

URL:

http://serverName:serverPort/rest/service/admin/repositories

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<storageRepositoryInfoList>
    <storageRepositoryInfo id="1">
        <name>TestRep1</name>
        <connectionInfo>&lt;connectionProperties&gt;&lt;property name='url' required='true'&gt; C:\TestRep1&lt;/property&gt;&lt;/connectionProperties&gt;</connectionInfo>
        <repositoryType>fileRepositoryAdapter</repositoryType>
        <repositoryTypeId>1</repositoryTypeId>
        <status>READ_WRITE</status>
        <statusId>1</statusId>
    </storageRepositoryInfo>
    <storageRepositoryInfo id="10">
        <name>TestRepA</name>
        <connectionInfo>&lt;connectionProperties&gt;&lt;property name='url' required='true'&gt; C:\TestRepA&lt;/property&gt;&lt;/connectionProperties&gt;</connectionInfo>
        <repositoryType>fileRepositoryAdapter</repositoryType>
        <repositoryTypeId>1</repositoryTypeId>
        <status>READ_WRITE</status>
        <statusId>1</statusId>
    </storageRepositoryInfo>
</storageRepositoryInfoList>

updateRepositories

Function

Update one or more storage repositories.

Description

This request is used to update the storage repositories on the system.

Type

POST

URL Format

..../admin/repositories

Java API

Method Name

Class Name

updateRepositories

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

storagerepositoryinfolist=<xml/>

 

Object containing the metadata of the storage repositories to be updated.

Returns

Returns a storageRepositoryInfoList object containing a list of all the successfully updated storage repositories.

Examples

URL:

http://serverName:serverPort/rest/service/admin/repositories?op=update&storagerepositoryinfolist=

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<storageRepositoryInfoList>
    <storageRepositoryInfo id="24">
        <name>QPP_Repo111</name>
        <connectionInfo>&lt;connectionProperties&gt;&lt;property name='url' required='false'&gt; \\dinesh-2k8\Repo1&lt;/property&gt;&lt;/connectionProperties&gt;</connectionInfo>
        <repositoryType>fileRepositoryAdapter</repositoryType>
        <repositoryTypeId>1</repositoryTypeId>
        <status>READ_WRITE</status>
        <statusId>1</statusId>
    </storageRepositoryInfo>
</storageRepositoryInfoList>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<storageRepositoryInfoList>
    <storageRepositoryInfo id="24">
        <name>QPP_Repo111</name>
        <connectionInfo>&lt;connectionProperties&gt;&lt;property name='url' required='false'&gt; \\dinesh-2k8\Repo1&lt;/property&gt;&lt;/connectionProperties&gt;</connectionInfo>
        <repositoryType>fileRepositoryAdapter</repositoryType>
        <repositoryTypeId>1</repositoryTypeId>
        <status>READ_WRITE</status>
        <statusId>1</statusId>
    </storageRepositoryInfo>
</storageRepositoryInfoList>

deleteRepository

Function

Delete a storage repository.

Description

This request is used to delete the specified storage repository.

Type

POST

URL Format

.../admin/repositories/{repositoryIdorName}

Java API

Method Name

Class Name

deleteRepository

com.quark.qpp.service.facade Class AdminFacade

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/admin/repositories/10?op=delete

createPrivileges

Function

Create Privileges.

Description

This request creates the required privilege definition(s).

Type

POST

URL Format

.../privileges?op=create

Java API

Method Name

Class Name

createPrivileges

com.quark.qpp.service.facadeClass AdminFacade

Parameters

Name

Type

Description

privilegedefinitionlist =<XML/>

string

A privilegeDefinitionList object in XML format. See "Request/Response parameter formats."

Returns

Returns a privilegeDefinitionList object containing the metadata of the newly created privileges.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privileges?op=create

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeDefinitionList>
    <privilegeDefinition name="Sample Privilege" id="2500000">
        <group id="100000">General</group>
        <statusBased>true</statusBased>
        <systemDefined>false</systemDefined>
        <contentPrivilege>true</contentPrivilege>
        <contentTypeInfoList>
            <contentTypeInfo id="1100">
                <name>Asset</name>
            </contentTypeInfo>
        </contentTypeInfoList>
    </privilegeDefinition>
</privilegeDefinitionList>

getPrivilege

Function

Get Privilege.

Description

This request returns a specific privilege(s) in system with given id or name.

Type

GET

URL Format

.../privileges/{privilegeIdOrName}

Java API

Method Name

Class Name

getPrivilege

com.quark.qpp.service.facadeClass AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns specific privilege(s) in system with given ID or name. If privilege name is specified and there exists multiple privileges in different privilege groups, with the given name, list of all such privileges will be returned.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privileges/Override Another Users Checkout

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeDefinitionList>
    <privilegeDefinition name="Override Another Users Checkout" id="1000003">
        <group id="100000">General</group>
        <statusBased>true</statusBased>
        <systemDefined>true</systemDefined>
        <contentPrivilege>true</contentPrivilege>
        <contentTypeInfoList>
            <contentTypeInfo id="1100">...</contentTypeInfo>
            <contentTypeInfo id="1101">...</contentTypeInfo>
            <contentTypeInfo id="1102">
                <name>Project</name>
            </contentTypeInfo>
            <contentTypeInfo id="1103">
                <name>Picture</name>
            </contentTypeInfo>
            <contentTypeInfo id="1104">...</contentTypeInfo>
            <contentTypeInfo id="1105">...</contentTypeInfo>
        </contentTypeInfoList>
    </privilegeDefinition> ..... .... </privilegeDefinitionList>

getAllPrivileges

Function

Get All Privileges.

Description

This request returns all privilege definitions in the system.

Type

GET

URL Format

.../privileges

Java API

Method Name

Class Name

getAllPrivileges

com.quark.qpp.service.facadeClass AdminFacade

Parameters

Name

Type

Description

contenttype=[true|false]

boolean

Defaul value is true

application=[true|false]

boolean

Defaul value is true

Returns

Returns a privilegeDefinitionList object containing the metadata of all privileges in the system.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privileges

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeDefinitionList>
    <privilegeDefinition name="Check In New" id="1000001">
        <group id="100000">General</group>
        <statusBased>false</statusBased>
        <systemDefined>true</systemDefined>
        <contentPrivilege>true</contentPrivilege>
        <contentTypeInfoList>
            <contentTypeInfo id="1100">
                <name>Asset</name>
            </contentTypeInfo>
            <contentTypeInfo id="1101">
                <name>Document</name>
            </contentTypeInfo>
            <contentTypeInfo id="1102">...</contentTypeInfo>
            <contentTypeInfo id="1103">...</contentTypeInfo>
            <contentTypeInfo id="1104">...</contentTypeInfo> ... </contentTypeInfoList>
    </privilegeDefinition> ..... ..... </privilegeDefinitionList>

getApplicableApplicationPriveleges

Function

Get applicable application privileges for the logged in user.

Description

This request returns enabled applicable application privileges for the logged in user. Applicable privileges are a union of all the privileges granted to him as a user as well as to groups of which the user is a member.

Type

GET

URL Format

../admin/users/

Java API

Method Name

Class Name

getApplicableApplicationPrivileges

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op= applicableapplicationprovileges

string

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

privileges= [comma-separated list of privilege Names or IDs]

string

The set of privilege values. (Optional)

Returns

Returns the applicationPrivList object containing all of the applicable applicaton privileges.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users? op=applicableapplicationprivileges

Result:

<applicationPrivList>
    <privilege id="140000023">
        <name>Delete</name>
        <privilegeHierarchy> Administration;Storage;Storage Rules;Delete </privilegeHierarchy>
    </privilege>
    <privilege id="140000022">
        <name>Create/Modify</name>
        <privilegeHierarchy> Administration;Storage;Storage Rules;Create/Modify </privilegeHierarchy>
    </privilege> .......... </applicationPrivList>
Get enabled applicable application privileges for the logged in user from the given privileges:URL:http://serverName:serverPort/rest/service/admin/users? op=applicableapplicationprivileges&privileges=140000023,...,Result:
<applicationPrivList>
    <privilege id="140000023">
        <name>Delete</name>
        <privilegeHierarchy> Administration;Storage;Storage Rules;Delete </privilegeHierarchy>
    </privilege>
    <privilege id="140000022">
        <name>Create/Modify</name>
        <privilegeHierarchy> Administration;Storage;Storage Rules;Create/Modify </privilegeHierarchy>
    </privilege> ........... </applicationPrivList>

getApplicableContentPrivileges

Function

Get applicable content privileges for the logged in user.

Description

This request returns enabled privileges of the given content type applicable for the logged in user. Applicable privileges are a union of all the privileges granted to him as a user as well as to groups of which the user is a member.

Type

GET

URL Format

../admin/users/

Java API

Method Name

Class Name

getApplicableContentPrivileges

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op= applicablecontentprovileges

string

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

contenttype=[contenType ID or Name or Hierarch]

string

 

privileges= [comma-separated list of privilege Names or IDs]

string

The set of privilege values. (Optional)

Returns

Returns the contentPrivList object containing all of the applicable content privileges.

Examples

URL:

http://serverName:serverPort/rest/service/admin/users? op=applicablecontentprivileges&contenttype=Picture

Result:

<contentTypePriv>
    <privilege id="3000006">
        <name>Change Workflow of Checked In Asset</name>
        <privilegeHierarchy> Edit Attributes;Change Workflow of Checked In Asset </privilegeHierarchy>
    </privilege>
    <privilege id="10000015">
        <name>Get Original Assets</name>
        <privilegeHierarchy>General;Get Original Assets</privilegeHierarchy>
    </privilege>
</contentTypePriv>
Get enabled applicable content privileges for the logged in user from the given privileges:URL:http://serverName:serverPort/rest/service/admin/users? op=applicablecontentprivileges&contenttype=Picture&privileges=3000006, 10000015Result:
<contentTypePriv>
    <privilege id="3000006">
        <name>Change Workflow of Checked In Asset</name>
        <privilegeHierarchy> Edit Attributes;Change Workflow of Checked In Asset </privilegeHierarchy>
    </privilege>
    <privilege id="10000015">
        <name>Get Original Assets</name>
        <privilegeHierarchy>General;Get Original Assets</privilegeHierarchy>
    </privilege>
</contentTypePriv>

updatePrivileges

Function

Update Privileges.

Description

This request updates the required privilege definition(s).

Type

POST

URL Format

.../privileges?op=update

Java API

Method Name

Class Name

updatePrivileges

com.quark.qpp.service.facadeClass AdminFacade

Parameters

Name

Type

Description

privilegedefinitionlist =<XML/>

string

A privilegeDefinitionList object in XML format. See "Request/Response parameter formats."

Returns

Returns a privilegeDefinitionList object containing the metadata of the successfully updated privileges.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privileges?op=update

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeDefinitionList>
    <privilegeDefinition name="Sample Privilege" id="2500000">
        <group id="100000">General</group>
        <statusBased>true</statusBased>
        <systemDefined>false</systemDefined>
        <contentPrivilege>true</contentPrivilege>
        <contentTypeInfoList>
            <contentTypeInfo id="1100">
                <name>Asset</name>
            </contentTypeInfo>
            <contentTypeInfo id="1102">
                <name>Project</name>
            </contentTypeInfo>
        </contentTypeInfoList>
    </privilegeDefinition>
</privilegeDefinitionList>

deletePrivilege

Function

Delete Privilege.

Description

This request deletes the specified privilege Id.

Type

POST

URL Format

.../privileges/{privilegeIdOrName}?op=delete

Java API

Method Name

Class Name

deletePrivilege

com.quark.qpp.service.facadeClass AdminFacade

Parameters

This request requires no input parameters.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/privileges/{privilegeIdOrName}?op=delete

createPrivilegeGroups

Function

Creates New Privilege Group.

Description

This request creates new privilege group along with its subgroups and privileges in the specified hierarchy.

Type

POST

URL Format

.../privilegegroups?op=create

Java API

Method Name

Class Name

createPrivilegeGroups

com.quark.qpp.service.facadeClass AdminFacade

Parameters

Name

Type

Description

privilegegroupdefinitionlist =<XML/>

string

A privilegeGroupDefinitionList object in XML format. See "Request/Response parameter formats."

Returns

Returns a privilegeGroupDefinitionList object containing the metadata of the successfuy created privilege groups.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privilegegroups?op=create

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeGroupDefinitionList>
    <privilegeGroupDefinition name="Sample Privilege Group">
        <privilegeDefinitionList>
            <privilegeDefinition name="Check In New" id="1000001">
                <group id="100000">General</group>
                <statusBased>false</statusBased>
                <systemDefined>true</systemDefined>
                <contentPrivilege>true</contentPrivilege>
                <contentTypeInfoList>
                    <contentTypeInfo id="1100">
                        <name>Asset</name>
                    </contentTypeInfo>
                    <contentTypeInfo id="1100">
                        <name>CustomeContentType_49933</name>
                    </contentTypeInfo>
                </contentTypeInfoList>
            </privilegeDefinition>
        </privilegeDefinitionList>
        <parentGroup id="-1"/>
    </privilegeGroupDefinition>
</privilegeGroupDefinitionList>

getPrivilegeGroup

Function

Get Privilege Group Definition.

Description

This request returns all existing privilege group definitions.

Type

GET

URL Format

.../privilegegroups/{privilegeGroupIdOrName}

Java API

Method Name

Class Name

getPrivilegeGroup

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns information for the specified privilege group based on its id or name specified.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privilegegroups/General

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeGroupDefinitionList>
    <privilegeGroupDefinition name="General" id="100000">
        <privilegeDefinitionList>
            <privilegeDefinition name="Check In New" id="1000001">
                <group id="100000">General</group>
                <statusBased>false</statusBased>
                <systemDefined>true</systemDefined>
                <contentPrivilege>true</contentPrivilege>
                <contentTypeInfoList>
                    <contentTypeInfo id="1100">
                        <name>Asset</name>
                    </contentTypeInfo> ... </contentTypeInfoList>
            </privilegeDefinition> ..... ..... </privilegeDefinitionList>
    </privilegeGroupDefinition>
</privilegeGroupDefinitionList>

getAllPrivilegeGroups

Function

Get All Privilege Group Definitions.

Description

This request returns all existing privilege group definitions.

Type

GET

URL Format

../privilegegroups

Java API

Method Name

Class Name

getAllPrivilegeGroups

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns all existing privilege group definitions. Each privilege group contains its information along with its privileges and sub-privilege group definitions.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privilegegroups

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeGroupDefinitionList>
    <privilegeGroupDefinition name="Administration" id="99998">...</privilegeGroupDefinition>
    <privilegeGroupDefinition name="Workspace" id="99999"> ... </privilegeGroupDefinition>
    <privilegeGroupDefinition name="General" id="100000">
        <privilegeDefinitionList>
            <privilegeDefinition name="Check In New" id="1000001">
                <group id="100000">General</group>
                <statusBased>false</statusBased>
                <systemDefined>true</systemDefined>
                <contentPrivilege>true</contentPrivilege>
                <contentTypeInfoList>
                    <contentTypeInfo id="1100">
                        <name>Asset</name>
                    </contentTypeInfo> ... </contentTypeInfoList>
            </privilegeDefinition> ..... ..... </privilegeDefinitionList>
    </privilegeGroupDefinition>
</privilegeGroupDefinitionList>
 

updatePrivilegeGroups

Function

Updates Given Privilege Group.

Description

This request updates the given privilege group.

Type

POST

URL Format

.../privilegegroups?op=update

Java API

Method Name

Class Name

updatePrivilegeGroups

com.quark.qpp.service.facadeClass AdminFacade

Parameters

Name

Type

Description

privilegegroupdefinitionlist =<XML/>

string

A privilegeGroupDefinitionList object in XML format. See "Request/Response parameter formats."

Returns

Returns a privilegeGroupDefinitionList object containing the metadata of the successfuy updated privilege groups.

Examples

URL:

http://serverName:serverPort/rest/service/admin/privilegegroups?op=update

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilegeGroupDefinitionList>
    <privilegeGroupDefinition name="Sample Privilege Group">
        <privilegeDefinitionList>
            <privilegeDefinition name="Check In New" id="1000001">
                <group id="100000">General</group>
                <statusBased>false</statusBased>
                <systemDefined>true</systemDefined>
                <contentPrivilege>true</contentPrivilege>
                <contentTypeInfoList>
                    <contentTypeInfo id="1100">
                        <name>Asset</name>
                    </contentTypeInfo>
                    <contentTypeInfo id="1100">
                        <name>CustomeContentType_49933</name>
                    </contentTypeInfo>
                </contentTypeInfoList>
            </privilegeDefinition>
        </privilegeDefinitionList>
        <parentGroup id="-1"/>
    </privilegeGroupDefinition>
</privilegeGroupDefinitionList>

deletePrivilegeGroup

Function

Deletes Given Privilege Group.

Description

This request deletes the given privilege group.

Type

POST

URL Format

.../privilegegroups/{privilegeGroupIdOrName}?op=delete

Java API

Method Name

Class Name

deletePrivilegeGroup

com.quark.qpp.service.facadeClass AdminFacade

Parameters

This request requires no input parameters.

Returns

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

Examples

URL:

http://serverName:serverPortt/rest/service/admin/privilegegroups/

{privilegeGroupIdOrName}?op=delete

addDomainValue

Function

Add a domain value.

Description

This request is used to add a new value in domain under the mentioned parent value. If the parent value Id is -1, then the domain value will be added at root level.

Type

POST

URL Format

.../domains/{domainIdOrName}/{newValueName}

Java API

Method Name

Class Name

addDomainValue

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=create

string

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

Parentvalue

string

Id/Name of the domain value under which new domain value is to be added.

sourcereference

string

Source reference of the new domain value.

position

string

Position among siblings where the domain value will be added.Can have values like 1, 5,....,(use -1 to add domain value at the end).

Returns

Returns metadata of the newly created domain value.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/501/SampleQPPDomainVal_a2b

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <domainValue id="1"> <name>SampleQPPDomainVal_a2b</name> <valueHierarchy>Desktop</valueHierarchy> <sourceReference>source</sourceReference> </domainValue>

getDomainValue

Function

Get Domain Value.

Description

This request returns desired DomainValue information.

Type

GET

URL Format

.../domains/{domainIdOrName}/{valueId}

Java API

Method Name

Class Name

getDomainValue

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns metadata of the specified domain value.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/Users/10

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <domainValue id="10"> <name>Admin2</name> <valueHierarchy>Desktop</valueHierarchy> </domainValue>

getDomainValueXml

Function

Get XML Value for Given Domain.

Description

This request returns xml value of the given domain value.

Type

GET

URL Format

.../domains/{domainIdOrName}/{valueId}

Java API

Method Name

Class Name

getDomainValueXml

com.quark.qpp.service.facadeClass SessionFacade

Parameters

Name

Type

Description

op=fetchxml

string

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

Returns

Returns xml value of the given domain value.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/{domainIdOrName}/{valueId}?op=fetchxml

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <sampleXMLvalue/>

setDomainValueXml

Function

Set XML Value for Given Domain.

Description

This request sets xml for the given domain value.

Type

POST

URL Format

.../domains/{domainIdOrName}/{valueId}

Java API

Method Name

Class Name

setDomainValueXml

com.quark.qpp.service.facadeClass SessionFacade

Parameters

Name

Type

Description

op=setxmlvalue

string

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

valueId=[]

string

Id of the domain value whose xml is to be set.

xmlvalue=[XML Dat]

string

XML Content.

Returns

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

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/ {domainIdOrName}/{valueId}?op=setxmlvalue&valueid={Id of Domain Value}&xmlvalue={XML Data}

searchDomainValues

Function

Search Domain with XML Values with matching Xpath Expression.

Description

This request finds domain values whose xml matches with the given xpath.

Type

GET

URL Format

.../domains/{domainIdOrName}

Java API

Method Name

Class Name

searchDomainValues

com.quark.qpp.service.facadeClass SessionFacade

Parameters

Name

Type

Description

op=searchvalues

string

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

xpath=[]

string

Expression to be used for finding required domain values.

 

Returns

Returns a domainValueList object whose xml matches with the given XPath.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/{domainIdOrName} ?op=searchvalues&xpath={xpath to match the XML Value for Defined Domain}

updateDomainValue

Function

Update a domain value.

Description

This request is used to updates the name and source reference of the domain value with the given ID.

Type

POST

URL Format

.../domains/{domainIdOrName}/{ValueId}

Java API

Method Name

Class Name

updateDomainValue

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=update

string

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

name

string

The new name for the domain value.

sourcereference

string

The source reference of the domain value to be updated.

Returns

Returns metadata of the successfully updated domain value.

Examples

URL:

http://serverName:serverPort/rest/service/admin/domains/501/1?op=update &name=NewName&sourcereference=updatedSourceRef

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<domainValue id="1">
    <name>newName</name>
    <valueHierarchy>Desktop</valueHierarchy>
    <sourceReference>updatedSourceRef</sourceReference>
</domainValue>

deleteDomainValue

Function

Delete a domain value.

Description

This request is used to delete the value of a domain.

Type

POST

URL Format

.../domains/{domainIdOrName}/{ValueId}

Java API

Method Name

Class Name

deleteDomainValue

com.quark.qpp.service.facade Class AdminFacade

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/admin/domains/501/1?op=delete

getFavorites

Function

Get all Favorites.

Description

This request returns all of the favorites items of the logged-on user.

Type

GET

URL Format

../admin/favorites

Java API

Method Name

Class Name

getFavorites

com.quark.qpp.service.facade Class AdminFacade

Parameters

This request requires no input parameters.

Returns

Returns a favoriteItemList object containing metadata of all of the favorites items for the logged-in user.

Examples

URL:

http://serverName:serverPort/rest/service/admin/favorites

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<favoriteItemlist>
    <favoriteItem position="1" type="QUERY" id="100">Default</favoriteItem>
    <favoriteItem position="2" type="COLLECTION" id="10">Home/Pictures</favoriteItem>
</favoriteItemlist>

setFavorites

Function

Set Favorites.

Description

This request sets the favorites items for the logged-in user.

Type

POST

URL Format

.../favorites

Java API

Method Name

Class Name

setFavorites

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

op=setfavorites

long

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

favoriteitemlist=[xml]

string

Object containing the metadata of the preference valuess to be updated.

Returns

Returns a favoriteItemList object containing the metadata of favorite items successfully set for logged-in user.

Examples

URL:

http://serverName:serverPort/rest/service/admin/preferencevalues?op=update&preferencevaluelist=<xml/>

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<favoriteItemlist>
    <favoriteItem position="1" type="QUERY" id="100">Default</favoriteItem>
    <favoriteItem position="2" type="COLLECTION" id="10">Home/Pictures</favoriteItem>
</favoriteItemlist>

getWorkflowInitiatingStatuses

Function

Get Workflow initial statuses.

Description

This request returns a list of "Workflow Initiating Statuses" for the given workflow. If the roleIdOrName parameter is specified then "Workflow Initiating Statuses" will be returned on the basis of overridden status transitions for the given userclass, otherwise the default initiating statuses are returned.

Type

GET

URL Format

.../workflows/{workflowIdOrName}

Java API

Method Name

Class Name

getWorkflowInitiatingStatuses

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

workflowinitiatingstatuses =true

boolean

 

role={ roleIdOrName }

string

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

Returns

Returns a statusInfoList object containing its metadata.

Examples

URL:

http://serverName:serverPort/rest/service/workflows/ Workflow1?workflowinitiatingstatuses=true&role=10

Result:

<?xml version="1.0" encoding="UTF-8"?>
<statusInfoList>
    <statusInfo id="10">
        <name>Status1</name>
        <domainId>6</domainId>
        <colorRed>50</colorRed>
        <colorGreen>150</colorGreen>
        <colorBlue>10</colorBlue>
        <position>1</position>
        <redlineTracking>false</redlineTracking>
        <checkInLayoutEvaluation>false</checkInLayoutEvaluation>
        <outputLayoutEvaluation>false</outputLayoutEvaluation>
        <privilegeInfoList>
            <privilegeInfo>
                <roleName>Administrator</roleName>
                <roleId>1</roleId>
                <overridden>false</overridden>
                <contentTypePrivList/>
            </privilegeInfo> ... </privilegeInfoList>
    </statusInfo>
</statusInfoList>

getStatusTransitions

Function

Get Status Transitions.

Description

This request returns the status transitions set for the given workflow. If the statusIdOrName parameter is specified, then status transitions for a particular status are returned. If the roleIdOrName parameter is specified, then the overridden transitions for the given role for particular workflow will be returned. Otherwise the default status transitions are returned.

Type

GET

URL Format

.../workflows/{workflowIdOrName}

Java API

Method Name

Class Name

getStatusTransistions

com.quark.qpp.service.facade Class AdminFacade

Parameters

Name

Type

Description

statustransitions =true

boolean

 

status={statusIdOrName}

string

The ID or Name of the status whose Status Transitions you wish to be retrieved."

role={ roleIdOrName}

string

The ID or Name of the role whose Status Transitions you wish to be retrieved ."

Returns

Returns an statusTransitionInfoList object containing a list of StatusTransitions set for the given workflow or workflow status for specified role.

Examples

URL:

http://serverName:serverPort/rest/service/workflows/ Workflow1?statustransitions=true&role=20

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<statusTransitionInfoList>
    <statusTransitionInfo id="10">
        <name>Status1</name>
        <workflowInitiatingStatus>true</workflowInitiatingStatus>
        <nextPossibleStatusInfoList>
            <nextPossibleStatusInfo id="11">
                <name>Status2</name>
            </nextPossibleStatusInfo>
        </nextPossibleStatusInfoList>
    </statusTransitionInfo>
    <statusTransitionInfo id="11">
        <name>Status2</name>
        <workflowInitiatingStatus>false</workflowInitiatingStatus>
    </statusTransitionInfo>
</statusTransitionInfoList>