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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
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:
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getUser
|
Function |
Get specific user. |
||
|
Description |
This request is used to fet the metadata of a specified user. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters |
||
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
getAllUsers
|
Function |
Get all users. |
||
|
Description |
This request is used to fetch all users. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters |
||
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
true |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns list of all the users along with their redlining colors. |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get Redline color for a given user. |
||
|
Description |
This request returns the defined redlining color for the given user. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
|
boolean |
|
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
updateUsers
|
Function |
Update users. |
||
|
Description |
This request is used to update a single user or multiple users at one time. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing a list of the successfully updated users . |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple content types URL:
Result:
|
||
deleteUser
|
Function |
Delete a user. |
||
|
Description |
This request is used to delete the specified user. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
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:
|
||
createGroups
|
Function |
Create groups. |
||
|
Description |
This request is used to create a single or multiple groups at one time. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing list of groups to be created. See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Multiple Groups Example: URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllGroups
|
Function |
Get all groups. |
||
|
Description |
This request returns all groups includin its members. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getGroupsWithGivenUserClass
|
Function |
Get groups with the given role. |
||
|
Description |
This request returns the Platform Server groups with the given role. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getUserGroups
|
Function |
Get groups of a user. |
||
|
Description |
This request returns all groups to which the given user belongs. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
updateGroups
|
Function |
Update groups. |
||
|
Description |
This request is used to update a single or multiple groups at one time. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
XML |
Object containing information for single or multiple groups. See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple groups: URL:
Result:
|
||
deleteGroup
|
Function |
Delete a group. |
||
|
Description |
This request is used to delete the group with the given id or name. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
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 |
||
|
Examples |
URL:
Result:
Example with multiple content types: URL:
|
||
|
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
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 |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The ID or Name of the content type to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing a list of the successfully updated content types . |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple content types: URL:
Result:
|
||
deleteContentType
|
Function |
Delete a content type. |
||
|
Description |
This request is used to delete the specified content type. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Id or Name of the content type to be deleted. |
|
|
|
string |
Attributes Ids or Names. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createAttributes
|
Function |
Create Attributes. |
||
|
Description |
This request is used to create a single or multiple attributes at one time. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of attributes to create. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple attributes: URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Content type IDs or Names. |
|
|
|
string |
Attributes IDs or Names. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: An |
||
updateAttributes
|
Function |
Update attributes. |
||
|
Description |
This request is used to update the metadata of a single or multiple attributes. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of attributes to be updated. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
Example with multiple attributes to update: URL:
Result:
|
||
deleteAttribute
|
Function |
Delete an Attribute. |
||
|
Description |
This request is used to delete an attribute with the specified id or name. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long 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:
|
||
createForms
|
Function |
Create forms. |
||
|
Description |
This request is used to create a new form in the system. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of forms to be created. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllForms
|
Function |
Get all forms. |
||
|
Description |
This request is used to get all forms saved in the system. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get forms with a specific workflow |
||
|
Description |
This request returns all forms specific to given workflow. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
ID or name of the workflow. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
ID or name of the content type. Mandatory. |
|
|
|
string |
ID of name of the worflow. Mandatory. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of forms to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple forms to update URL:
Result:
|
||
deleteForm
|
Function |
Delete a form. |
||
|
Description |
This request is used to delete the specified form. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createRoles
|
Function |
Create roles. |
||
|
Description |
This request is used to create one or more roles/userclass in a single request. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing a list of the roles to be created. See the |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getRole
|
Function |
Get a specific userclass/role. |
||
|
Description |
This request returns the metadata of specified userclass/role. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
OR
|
string |
The ID or Name of the role to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllRoles
|
Function |
Get all userclasses/roles. |
||
|
Description |
This request returns all the userclasses with its metadata. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
updateRoles
|
Function |
Update roles. |
||
|
Description |
This request is used to update the metadata of a specified single or multiple roles. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing the metadata of the roles to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple roles URL:
Result:
|
||
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:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of relation types to create. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple relation types URL:
Result:
|
||
getRelationType
|
Function |
Get Relation Type. |
||
|
Description |
This request is used to get the metadata of a specified relation type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The ID or name of the relation type that is to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllRelationTypes
|
Function |
Get all relationship types. |
||
|
Description |
This request returns all the relation types with their attributes. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
updateRelationTypes
|
Function |
Update relation types. |
||
|
Description |
This request is used to update the metadata of user defined relation types. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of relation types to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple relation types to update URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long 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:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of attribute domains to create. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple domains URL:
Result:
|
||
getDomain
|
Function |
Get Attribute Domain. |
||
|
Description |
This request is used to get the metadata of a specified attribute domain. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The ID or name of the domain that is to be retrieved. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of domains to be updated. |
|
|
Returns |
Returns an attributeDomainInfoList object containing a list of successfully updated domains. |
||
|
Examples |
URL:
Result:
Example with multiple attribute domains to update URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long 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:
|
||
createLdapProfiles
|
Function |
Create LDAP profiles. |
||
|
Description |
This request is used to create one or more LDAP profiles. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing a list of the LDAP profiles to be created. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
Example with multiple LDAP profiles URL:
Result:
|
||
getLdapProfile
|
Function |
Get an LDAP profile. |
||
|
Description |
This request returns the metadata of a specified LDAP profile. |
||
|
Type |
Get |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The ID or Name of the LDAP profile to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllLdapProfiles
|
Function |
Get all LDAP profiles. |
||
|
Description |
This request returns all the LDAP profiles saved on the system. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing a list of the successfully updated LDAP profiles. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
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:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Specify the name of the LDAP Query. (Mandatory) |
|
|
|
string |
Specify the name of the LDAP profile. (Mandatory) |
|
|
|
string |
Specify the base string to fetch LDAP users.(Mandatory) |
|
|
|
string |
Specify the filter to filter the users. (Mandatory) |
|
|
|
string |
The Quark Publishing Platform Server's UserRole. After fetching users from LDAP Server users will be created with this UserRole. (Mandatory) |
|
|
|
string |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Specify the name of the LDAP profile. (Mandatory) |
|
|
|
|
Specify the base string to fetch LDAP users. (Mandatory) |
|
|
|
|
Specify the filter to filter the users. (Mandatory) |
|
|
|
|
The Quark Publishing Platform Server's UserRole. After fetching users from LDAP Server users will be created with this UserRole. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Specify the name of the saved LDAP Users search. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
|
|
|
|
long |
|
|
|
|
long |
|
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
op=importgroups |
string |
|
|
|
Option 1. Mention the following parameters (ldapprofile,basestring,searchfilter) to form LDAP search criteria:- |
|||
|
|
long |
name or id of the LDAP profile |
|
|
|
string |
base DN under which groups are to be searched. e.g. basestring=dc=india,dc=myorg,dc=com |
|
|
|
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
|
long/string |
name or id of the saved LDAP query from which groups & users are to be imported. |
|
|
|
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 |
||
|
Examples |
URL: Option 1-Import based on LDAP profile, search filter and base string
Option 2 – Import based on saved LDAP query
Result:
|
||
|
|
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createLdapSearches
|
Function |
Create LDAP search definitions. |
||
|
Description |
This request creates creates LDAP search definitions. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
|
|
See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllLdapSearches
|
Function |
Get all saved LDAP search definitions. |
||
|
Description |
This request returns all saved LDAP search definitions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
updateLdapSearches
|
Function |
Update LDAP search definitions. |
||
|
Description |
This request update the given LDAP search definitions. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
|
|
See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
com.quark.qpp.service.facade Class AdminFacade |
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
|
string |
|
|
|
|
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:
|
||
createWorkflows
|
Function |
Create workflows. |
||
|
Description |
This request is used to create one or more workflows and their statuses. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing a list of the workflows to be created. See the workflowInfoList paramater in "Request/Response parameter formats". |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a workflow |
||
|
Description |
This request returns the metadata and status of a specified workflow. |
||
|
Type |
Get |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The ID or Name of the workflow to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing a list of the successfully updated workflows . |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
deleteWorkFlow
|
Function |
Delete a workflow. |
||
|
Description |
This request is used to delete the specified workflow. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
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:
|
||
createPreferences
|
Function |
Create Preferences. |
||
|
Description |
This request is used to create a single or multiple preferences at one time. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of preferences to create. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getPreference
|
Function |
Get a specific preference. |
||
|
Description |
This request returns the metadata of a specified preference. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The ID or Name of the preference to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllPreferences
|
Function |
Get all Preferences. |
||
|
Description |
This request returns all of the existing preference definitions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Comma separated list of Ids or Names of Preferences to be retrieved. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
updatePreferences
|
Function |
Update Preferences. |
||
|
Description |
This request is used to update the metadata of a specified single or multiple preferences. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing the metadata of the preferences to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
updatePreferenceValues
|
Function |
Update Preference Values. |
||
|
Description |
This request updates the preference values corresponding to the logged-in user. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Object containing the metadata of the preference valuess to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
deletePreference
|
Function |
Delete a preference. |
||
|
Description |
This request is used to delete the specified preference. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createRepositories
|
Function |
Create one or more storage repositories. |
||
|
Description |
This request is used to create new storage repositories. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
List of storage repositories to create. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getRepository
|
Function |
Get a specific repository. |
||
|
Description |
This request returns a storage repository with the given Id or Name. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The ID or Name of the repository to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllRepositories
|
Function |
Get all storage repositories. |
||
|
Description |
This request returns all the information regarding all repositories registered with the platform. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
|
Object containing the metadata of the storage repositories to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
deleteRepository
|
Function |
Delete a storage repository. |
||
|
Description |
This request is used to delete the specified storage repository. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createPrivileges
|
Function |
Create Privileges. |
||
|
Description |
This request creates the required privilege definition(s). |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
A privilegeDefinitionList object in XML format. See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getPrivilege
|
Function |
Get Privilege. |
||
|
Description |
This request returns a specific privilege(s) in system with given id or name. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
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:
Result:
|
||
getAllPrivileges
|
Function |
Get All Privileges. |
||
|
Description |
This request returns all privilege definitions in the system. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaul value is true |
|
|
|
boolean |
Defaul value is true |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The set of privilege values. (Optional) |
|
|
Returns |
Returns the |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
|
|
|
|
string |
The set of privilege values. (Optional) |
|
|
Returns |
Returns the |
||
|
Examples |
URL:
Result:
|
||
updatePrivileges
|
Function |
Update Privileges. |
||
|
Description |
This request updates the required privilege definition(s). |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
A privilegeDefinitionList object in XML format. See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
deletePrivilege
|
Function |
Delete Privilege. |
||
|
Description |
This request deletes the specified privilege Id. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
A |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getPrivilegeGroup
|
Function |
Get Privilege Group Definition. |
||
|
Description |
This request returns all existing privilege group definitions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns information for the specified privilege group based on its id or name specified. |
||
|
Examples |
URL:
Result:
|
||
getAllPrivilegeGroups
|
Function |
Get All Privilege Group Definitions. |
||
|
Description |
This request returns all existing privilege group definitions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
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:
Result:
|
||
updatePrivilegeGroups
|
Function |
Updates Given Privilege Group. |
||
|
Description |
This request updates the given privilege group. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
A |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
deletePrivilegeGroup
|
Function |
Deletes Given Privilege Group. |
||
|
Description |
This request deletes the given privilege group. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Id/Name of the domain value under which new domain value is to be added. |
|
|
|
string |
Source reference of the new domain value. |
|
|
|
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:
Result:
|
||
getDomainValue
|
Function |
Get Domain Value. |
||
|
Description |
This request returns desired DomainValue information. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns metadata of the specified domain value. |
||
|
Examples |
URL:
Result:
|
||
getDomainValueXml
|
Function |
Get XML Value for Given Domain. |
||
|
Description |
This request returns xml value of the given domain value. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
Returns xml value of the given domain value. |
||
|
Examples |
URL:
Result:
|
||
setDomainValueXml
|
Function |
Set XML Value for Given Domain. |
||
|
Description |
This request sets xml for the given domain value. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Id of the domain value whose xml is to be set. |
|
|
|
string |
XML Content. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Expression to be used for finding required domain values. |
|
|
|
|||
|
Returns |
Returns a |
||
|
Examples |
URL:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The new name for the domain value. |
|
|
|
string |
The source reference of the domain value to be updated. |
|
|
Returns |
Returns metadata of the successfully updated domain value. |
||
|
Examples |
URL:
Result:
|
||
deleteDomainValue
|
Function |
Delete a domain value. |
||
|
Description |
This request is used to delete the value of a domain. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getFavorites
|
Function |
Get all Favorites. |
||
|
Description |
This request returns all of the favorites items of the logged-on user. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
setFavorites
|
Function |
Set Favorites. |
||
|
Description |
This request sets the favorites items for the logged-in user. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
Object containing the metadata of the preference valuess to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
string |
The ID or Name of the role whose Workflow Initiating Statuses you wish to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
string |
The ID or Name of the status whose Status Transitions you wish to be retrieved." |
|
|
|
string |
The ID or Name of the role whose Status Transitions you wish to be retrieved ." |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
