favorite-folders Collection

Description

The collection of folders for public and private user settings.

URL

/qcbin/rest/domains/{domain}/projects/{project}/favorite-folders

Remarks

A folder in one module can be identical to a folder in another module in every attribute except the module-id and the id.

For each module, there is a Private and a Public pre-defined favorites folder.

For the list of module IDs in your project, see the MODULES table in the project database.

For bulk updates, deletions, and creation, see Bulk Operations.

HTTP Methods

GET: Retrieves the collection of favorite folders.

PUT: Bulk update with type=collection.

DELETE: Bulk deletion with type=collection.

POST: Creates a favorite folder. Bulk creation with type=collection.

Media Type
GET
PUT
DELETE
POST
application/xml
check
-
-
check
application/json
check
-
-
check
application/xml;type=collection - check check check
application/json;type=collection - check check check

Returns

One of the HTTP Return Codes.

A JSON string of the same format as the data returned with a GET operation.

Examples

GET favorite folders XML