resource-list

Description

A document detailing all available resources and the actions they expose.

URL

/qcbin/rest/resource-list

Remarks

The returned value contains the URLs, supported HTML methods, and mime types. The values possible for Content-Type are in Consumes elements. The values possible for Accept are in Produces elements. For example:

    <Consumes>application/xml</Consumes>
    <Consumes>application/json</Consumes>
    <Produces>application/xml</Produces>
    <Produces>application/json</Produces>

OpenText advises you to use only the resources documented in the ALM REST API Reference. Any resources included in the REST API that are not documented are not intended for public use. Be aware that OpenText does not support the use of undocumented resources by customers.

HTTP Methods

GET: The collection of available resources.

PUT: N/A

DELETE: N/A

POST: N/A

Media Type
GET
PUT
DELETE
POST
application/xml
check
-
-
-
application/json
check
-
-
-

Returns

One of the HTTP Return Codes.

An XML string compliant with the resource-list Schema or a string containing the data in another supported format.

Examples

GET Resource List Example