The GET Catalog Information API returns JSON metadata about a catalog of Ad Hoc reports and data services in Pull Reports™. The metadata includes the catalog's id and name.
The GET Catalog Information endpoint returns meta information about a single <catalog>
or all <catalog>s including id, name
and child <report>s. When requested with a [catalog id],
the endpoint returns information for just one <catalog>. When requested at the
/catalog root resource path, the endpoint returns meta information
for all <catalog>s within the Pull Reports™ installation.
/[context]/pullreports/catalog/[catalogId].json
/[context]/pullreports/catalog.json
Only <catalog>s and <report>s which pass any associated
<access_control_voter>s are returned in the response.
Accept request headerInstead of to appending .json to the end of the URL,
it is permitted to use the application/json Accept request header.
If true, "pretty" formats the returned JSON with white space and
end-of-line characters.
Response Content-Type:
application/json
Status Code: 200
JSON responses without error have this structure:
{
// Array of the configured <catalog>s which pass any configured <access_control_voter>s
"data":[
{
"id":"string" // The id of the <catalog>
,"name":"string" // The name of the <catalog>
// Array of <report>s within this <catalog> which pass any
// configured <access_control_voter>s
,"reports":[
{
"id":"string" // The id of the <report>
,"name":"string" // The name of the <report>
,"description":"string" // The <description> of the <report>
// Array of <canned_query>s within this <report> which pass any
// configured <access_control_voter>s
,"namedQueries":[
"id":"string" // The id of the <canned_query>
,"name":"string" // The name of the <canned_query>
,"description":"string" // The <description> of the <canned_query>
// type is of: "canned", "user"
,"type":"string"
]
}
]
}
]
}
Status Code: 403
Requests to the single catalog URL which do not pass an <access_control_voter> associated with the
<catalog> return a 403 response.