Reporting - List Report Definitions

URI

https://164.99.19.131:8443/SentinelRESTServices/rpt/definitions

Supported Methods

GET

This report lists reports known to the system. This list can be sorted, filtered, and have a from/to specified.

Authentication

Authentication Types

X-SAML

Sentinel Permissions Needed

URL Parameters

Required

Parameter	Type	Description
`filterDisplayName`	List	'contains ignore case' filter on DisplayName, when occurring in URL multiple times, the filter strings are ANDed together
`filterDescription`	List	'contains ignore case' filter on Description, when occurring in URL multiple times, the filter strings are ANDed together
`filterTags`	List	'contains ignore case' filter on Tags, when occurring in URL multiple times, the filter strings are ANDed together

Optional

Parameter	Type	Default Value	Description
`sortBy`	String	DisplayName	The column to sort by. Valid values: DisplayName, Description, Tags.
`sortOrder`	String	ASC	The sort order. Valid values: ASC or DESC
`idxFrom`	int	0	The starting row index. 0 is the first.
`idxTo`	int	2147483647	The ending row index, inclusive.

Success Codes

200 OK

Fault Codes

400 Bad Request
400 with NCAC Fault Data
- Code ValueSender
- Subcode Value: InvalidOrderBy
- Reason Text: Invalid sortOrder url parameter specified: ASCENDING. Valid values are ASC, DESC
400 with NCAC Fault Data
- Code ValueSender
- Subcode Value: InvalidSortrBy
- Reason Text: Invalid sort by url parameter specified: TEST. Valid values are DisplayName, Description, and Tags.
400 with NCAC Fault Data
- Code ValueSender
- Subcode Value: InvalidTemplateRange
- Reason Text: Invalid Report Range Specified. The value for 'From' must be less than the 'To' value. Values were '10' for the 'From' value and '1' for the 'To' value.

Sample Request

GET /rpt/definitions?SortBy=DisplayName,sortOrder=ASC,idxFrom=0,idxTo=100

Sample Response for application/json

Status: 200

{ "TotalSize":2, "Definitions":[&#10;{"GUID":"myResource1", "DisplayName":"My Resource 1", "Description":"My Resource 1 Description", "Tags":["resource"], "Link":"/acme/rpt/definitions/myResource1"},&#10;{"GUID":"myResource2", "DisplayName":"My Resource 2", "Description":"My Resource 2 Description", "Tags":["resource"], "Link":"/acme/rpt/definitions/myResource2"}] }&#10;

Sample Request

GET /rpt/definitions?filterDescription=2

Sample Response for application/json

Status: 200

{ "TotalSize":1, "Definitions":[&#10;{"GUID":"myResource2", "DisplayName":"My Resource 2", "Description":"My Resource 2 Description", "Tags":["resource"], "Link":"/acme/rpt/definitions/myResource2"}] }&#10;

Sample Request

GET /rpt/definitions?sortBy=DisplayName,sortOrder=ASCENDING,idxFrom=0,idxTo=100

Sample Response for application/json

Status: 200

{"Fault":{ "Code":{"Value":"Sender", "Subcode":{"Value":"InvalidOrderBy"} },&#10;"Reason":{"Text":"Invalid sortOrder url parameter specified: ASCENDING. Valid values are ASC, DESC"} } }&#10;

Back to main API page