Get analysis details
/api/20210901/catalog/analysis/{urlBase64AnalysisId}
Request
-
urlBase64AnalysisId(required): string
Analysis id with Base64URL encoding. For example, if you have an analysis with id '/myuser/samplefolder/samplesales', enter the Base64URL encoded value 'L215dXNlci9zYW1wbGVmb2xkZXIvc2FtcGxlc2FsZXM='.
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
object
400 Response
403 Response
500 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
- Example 1 - No field criteria
- Example 2 - Multiple field criteria
Example 1 - No field criteria
In this example, you return the details of an existing analysis with the
given ID without specifying fields to return. Listing no fields returns all details
except for content
. The object ID of the analysis is
'/shared/Sales/Sales Analysis' which has the Base64URL-safe encoded ID value:
L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw
. You can get the ID of
an analysis by using Get catalog items by type.
cURL Example:
curl --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/catalog/analysis/L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw'
Example of Request Body
Not applicable.
Example of Response Body
{ "owner": "smith", "name": "/shared/Sales/Sales Analysis", "description": "Sales Analysis", "id": "L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw", "last modified": "2025-01-01T19:53:07Z", "type": "analyses", "parent": "L3NoYXJlZC9TYWxlcy8", }
Example 2 - Multiple field criteria
In this example, you return the details of an existing analysis with the
given ID. Which details are returned is determined by listed fields after
?fields=
, in this case the analysis name, description, and
content details. The object ID of the analysis is '/shared/Sales/Sales Analysis'
which has the Base64URL-safe encoded ID value:
L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw
.
cURL Example:
curl --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/catalog/analysis/L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw?fields=name,description,content'
Example of Request Body
Not applicable.
Example of Response Body
{ "name": "shared/Sales/Sales Analysis", "description": "Sales Analysis", "content": "<analysis-xml-string>" }