Collection management
The collection management capabilities of the API allow application developers to manage collections and includes the following REST calls:
createCollection
|
Function |
Create a collection. |
||
|
Description |
This request creates a new collection according to the given attributes. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
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 parent collection for the new collection. (Mandatory) There is a choice between collection ID, Name and Path when providing a value. |
|
|
|
string |
The set of attribute values. See "Request/Response parameter formats."(All atributes are Optional) |
|
|
|
string |
Defaults to GENERAL. The default content type IDs are documented in the JavaDoc SDK at To get a list of content types, use a call to There is a choice between content type ID, Name and Hierarchy when providing a value. |
|
|
Returns |
Returns the |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Create a collection template. |
||
|
Description |
This request creates a new collection template under the given parent collection. |
||
|
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) |
|
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
|
long or string |
The parent collection for the new collection. (Mandatory) |
|
|
|
string |
The set of attribute values. See "RequestResponse parameter formats." All attributes are Optional. |
|
|
|
string |
Defaults to GENERAL. The default content type IDs are documented in the JavaDoc SDK at To get a list of content types, use a call to |
|
|
Returns |
Returns the |
||
|
Examples |
URL:
Result:
|
||
createCollections
|
Function |
Create multiple collections. |
||
|
Description |
This request creates multiple collections in a single request. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
|
|
See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getCollection
|
Function |
Get all of a collection's metadata. |
||
|
Description |
This request returns all of the metadata associated with an entire collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get specific collection attributes. |
||
|
Description |
This request returns all of the attrubutes associated with a specific collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
To get a list of all attribute IDs, use a call to |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's workflows. |
||
|
Description |
This request returns all of the workflows associated with a collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
com.quark.qpp.service.facade Class CollectionFacade |
||
|
Parameters |
Name |
Type |
Description |
|
workflows=[true|false] |
boolean |
Defaults to false. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's workflow for a specific content type. |
||
|
Description |
This request returns all of the workflows associated with a specific content type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
|
long |
The default content type IDs are documented in the JavaDoc SDK at |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's users. |
||
|
Description |
This request returns a list of the users of a collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's groups. |
||
|
Description |
This request returns a list of the groups associated with a collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get the routings for a collection's workflow. |
||
|
Description |
This request returns all of the routings for a collection's workflow. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
|
long or string |
Specify the workflow name or ID. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's revision controls. |
||
|
Description |
This request returns all of the revision controls for a collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's Job Jackets files. |
||
|
Description |
This request returns all of the job jackets for a collection. |
||
|
Type |
GET |
||
|
URL Format |
.../collections/[collection ID] or collectionsbypath/[collection path] |
||
|
Java API |
Method Name |
Class Name |
|
|
getCollection |
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's child collections. |
||
|
Description |
This request returns immediate child collections accessible to the logged on user. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get a collection's parent collection. |
||
|
Description |
This request returns all of the accessible parent collections for a collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get collection assets and specify asset display attributes. |
||
|
Description |
This request returns collection assets by considering asset display attributes. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
(Mandatory) |
|
|
|
long or string |
An array of display attributes IDs or names to be used while querying for assets within a collection. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get all collections in the hierarchy of the given collection along with assets and specific asset display attributes. |
||
|
Description |
This request returns a complete collection hierarchy of the given collection alon with collection assets with specific asset display attributes. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
(Mandatory) |
|
|
|
boolean |
(Mandatory) |
|
|
|
long or string |
An array of display attributes IDs or names to be used while querying for assets within a collection. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getCollectionHierarchy
|
Function |
Get the metadata of each collection in the hierarchy. |
||
|
Description |
This request returns all of the metadata associated with each collection in the hierarchy |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
ParametersReturns |
Name |
Type |
Description |
|
|
boolean |
Defaults to true. (Mandatory) |
|
|
|
string |
To get a list of all attribute IDs, use a call to |
|
|
|
boolean |
Defaults to false. (Optional) |
|
|
|
boolean |
Defaults to false. (Optional) |
|
|
|
boolean |
Defaults to false. (Optional) |
|
|
|
boolean |
Defaults to false. (Optional) |
|
|
|
boolean |
Defaults to false. (Optional) |
|
|
|
boolean |
Defaults to false. (Optional) |
|
|
|
string |
The default content type IDs are documented in the JavaDoc SDK at This parameter can be concatenated with above mentioned parameters workflows and revision controls. |
|
|
Returns a |
|||
|
Examples |
URL:
Result:
|
||
getCollectionDefaultJobJacket
|
Function |
Get the default Job Jackets file for a collection. |
||
|
Description |
This request returns the default job jacket set for a collection. Returns null if no job jacket is specified as default for this collection or the content of the job jacket is not found. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
op= |
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getCollectionDefaultTicket
|
Function |
Get the default Job Ticket for a collection. |
||
|
Description |
This request returns the default Job Ticket for the collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
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 the name of the default job ticket for a collection. |
||
|
Examples |
URL:
Result: Default Job Ticket. The name of the default job ticket for a collection. |
||
moveCollection
|
Function |
Move a collection. |
||
|
Description |
This request moves a collection or collection template from one level to another. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request moves a collection along with its child collections and assets under a new parent collection. |
|
|
|
long or string |
The collection to which this collection should be moved. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
duplicateCollection
|
Function |
Duplicate a collection. |
||
|
Description |
This request duplicates a given collection or collection template. |
||
|
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 name of the new collection. (Mandatory) |
|
|
|
long or string |
The collection where the duplicate collection should be put. (Mandatory)There is a choice between collection ID, Name and Path when providing a value. |
|
|
|
boolean |
True to also duplicate assets. Defaults to false.(Optional) If assets = true, then the metadata flags like |
|
|
|
boolean |
This parameter will only work if |
|
|
|
boolean |
Parameter to duplicate collection with or without its child collections. Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to duplicate collection with or without workflows. Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to duplicate collection with or without users. Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to duplicate collection with or without Status Routing Settings. Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to duplicate collection with or without JobJackets. Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to duplicate collection with or without RevisionControl Settings. Defaults to true.(Optional) |
|
|
Returns |
Returns the |
||
|
Examples |
URL:
Result:
|
||
updateCollection
|
Function |
Update a collection. |
||
|
Description |
This request updates the metadata of a given collection or collection template. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The set of attribute values. See "Request/Response parameter formats."(Mandatory) |
|
|
|
long or string |
To update given collection's workflows. To get the IDs of all workflows, use a call
to |
|
|
|
GroupInfoList |
To update given collection's workflows.To get the IDs of all groups, use a call to
|
|
|
|
long or string |
To update given collection's JobJackets. To get a list of Job Jackets and their IDs
for a collection, use a call to |
|
|
|
xml |
To update given collection's Status Routing Settings.See "Request/Response parameter formats."(Optional) |
|
|
|
string |
To update given collection's Default JobJacket Ticket Name.To get the name of Job
Ticket for a collection, use a call to |
|
|
|
boolean |
Parameter to override settings on its child collection. Defaults to false. (Optional) If this parameter is supplied, it will override the previous settings on its child collections. Used parameters ( e.g. Workflows) will not be removed in case the used workflow doesn't exist in the newly supplied parameters. |
|
|
|
boolean |
Parameter to merge settings on its child collection. (Optional)Defaults to false. true is equivalent to Apply settings to child Collections: Merge in Platform. Supplied parameter settings will be merged to previous settings of its child collections. |
|
|
|
xml |
To update given collection's Users. See "Request/Response parameter formats."(Optional) |
|
|
|
xml |
To update given collection's Revision Control Settings. See "Request/Response parameter formats."(Optional) |
|
|
Returns |
Returns the |
||
|
Examples |
URL:
Result:
|
||
updateCollections
|
Function |
Update multiple collections. |
||
|
Description |
This request updates multiple collections in a single request. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
|
|
See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
deleteCollection
|
Function |
Delete a collection. |
||
|
Description |
This request deletes the specified collection or collection template. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This request works only for empty collections. This means a collection can only be deleted if the collection and all of its child collection do not have any assets in them. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
deleteCollectionWithAssets
|
Function |
Delete a collection with assets. |
||
|
Description |
This request deletes the given collection from the system along with its sub-collections and assets. Only users who have access to the given collection are allowed to delete the collection. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
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:
|
||
createJobjackets
|
Function |
Create a Job Jackets file. |
||
|
Description |
This request creates new job jacket after parsing the content supplied and returns and object of the newly created Job Jacket. Stream the Job Jackets XML into the request body or send it as a file part. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
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 a |
||
|
Examples |
URL:
Result: A |
||
getJobjacket
|
Function |
Get a Job Jackets file with a specific ID. |
||
|
Description |
This request returns the specified job jacket. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllJobJackets
|
Function |
Get all Job Jackets. |
||
|
Description |
This request returns all the metadata of Job Jackets available 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:
|
||
getJobJacketContent
|
Function |
Get the contents of a Job Jackets file. |
||
|
Description |
This request returns the actual content of a specified job jacket in xml format. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
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) |
|
|
|
|
To get a list of Job Jackets and their IDs for a collection, use a call to |
|
|
Returns |
Returns the actual content of a specified job jacket in XML format |
||
|
Examples |
URL:
Result:
|
||
updateJobJacket
|
Function |
Update a job jacket. |
||
|
Description |
This request updates the contents of a specified job jacket. |
||
|
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.Pass the xml of the job jacket file as file stream in the request body. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
updateJobJackets
|
Function |
Update multiple job jackets |
||
|
Description |
This request updates the contents of multiple job jackets in a single request. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id. |
|
|
|
|
See "Request/Response parameter formats." |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
parseJobJacketXml
|
Function |
Parse a Job Jackets file. (Include the file in the request body or as file part.) |
||
|
Description |
This request parses the jobjacket xml and returns a JobJacket object containing the jobjacket name and ticket names. |
||
|
Type |
POST |
||
|
URL Format |
.../collections |
||
|
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 a |
||
|
Examples |
URL:
Result:
|
||
deleteJobJacket
|
Function |
Delete a Job Jackets file. |
||
|
Description |
This request deletes the jobjacket 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) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getApplicableRoutingUsers
|
Function |
Get Applicable Routing Users |
||
|
Description |
This request returns a list of applicable routing users for the given collection for specified workflow and status. This will return all collection mapped users having the same userclass as any of the status mapped userclasses. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
string |
The ID or Name of the workflow whose Routing Users you wish to be retrieved. |
|
|
|
string |
The ID or Name of the status whose Routing Users you wish to be retrieved. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
getApplicablePrivileges
|
Function |
Get applicable privileges for the logged in user. |
||
|
Description |
This request returns the privileges applicable for the logged in user for the given collection. These privileges are a union of the privileges of the following user clases:Userclass of the logged in user in the given collection, only if the user is mapped to the given collection.Userclasses of collection mapped groups of which the logged in user is a member. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
long |
The ID or Name of the status whose privileges you wish to be retrieved. |
|
|
|
long |
The default content type IDs are documented in the JavaDoc SDK at If not provided, the metadata of all conent types will be returned. |
|
|
|
string |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get enabled content type privileges. |
||
|
Description |
This request returns only contenttype based privileges applicable for the logged in user for the given collection. These privileges are a union of the privileges of the following user clases:Userclass of the logged in user in the given collection, only if the user is mapped to the given collection.Userclasses of collection mapped groups of which the logged in user is a member. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
(Mandatory) |
|
|
|
long |
The default content type IDs are documented in the JavaDoc SDK at c If not provided, the metadata of all conent types will be returned. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get all enabled status privileges. |
||
|
Description |
This request returns the privileges applicable for the logged in user for the given collection and status (Status based overridden privileges) . These privileges are a union of the privileges of the following user clases: Userclass of the logged in user in the given collection, only if the user is mapped to the given collection.Userclasses of collection mapped groups of which the logged in user is a member. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
boolean |
The ID or Name of the status whose privileges you wish to be retrieved. |
|
|
|
long or string |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getApplicableRoutingGroups
|
Function |
Get applicable routing groups for the logged in user. |
||
|
Description |
This request returns an array of applicable routings groups for the given collection for the specified workflow and status. This will return all collection mapped groups whose userclass is the same as one of the status mapped userclasses. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
long or string |
The ID or Name of the workflow whose routing groups you wish to be retrieved. |
|
|
|
long or string |
The ID or Name of the status whose routing groups you wish to be retrieved. |
|
|
Returns |
Returns a list of applicable routing |
||
|
Examples |
URL:
Result:
|
||
getApplicableAttributeConstraints
|
Function |
Get applicable attribute constraints for the logged in user. |
||
|
Description |
This request returns attribute constraints applicable to the given status and collection for the logged in user. The user may have multiple userclasses, due to its membership in multiple groups which are mapped to the collection with different userclasses. Since attribute constraints are defined per userclass, multiple constraints in such cases are evaluated and the most permissive set of attribute constraints is returned. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
long or string |
The ID or Name of the status whose attributes constraints you wish to be retrieved. |
|
|
|
long or string |
|
|
|
Returns |
Returns a list of applicable |
||
|
Examples |
URL:
Result:
|
||
getApplicableStatusTransition
|
Function |
Get applicable status transitions for the logged in user. |
||
|
Description |
This request returns the applicable status transition for the given workflow, status and collection for the logged in user. If the status transition is overridden for the given userclass, then overridden will be considered. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
long or string |
The ID or Name of the workflow whose status transitions you wish to be retrieved. |
|
|
|
long or string |
The ID or Name of the status whose status transitions you wish to be retrieved. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getApplicableWorkflowInitialStatuses
|
Function |
Get applicable workflow initial statuses. |
||
|
Description |
This request returns the initial applicable statuses for the given workflow and collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
long or string |
The ID or Name of the workflow whose workflow Initiating Statuses you wish to be retrieved. |
|
|
Returns |
Returns a list of |
||
|
Examples |
URL:
Result:
|
||
