Retrieving view data using the Common REST API

Authorization

header

Authorization token formatted as 'Bearer [token]'

Context of the server from which you want to retrieve data

Default: *

Server from which you want to retrieve data, usually the SSID

Default: *

System from which you want to retrieve data, usually the LPAR

Default: *

Scope for which you want to retrieve data

Default: *

Whether to refresh the data for the request

Possible values are:

Y – Refresh the view data.  BMC recommends using this option for the initial request.  

N – For subsequent requests, to get the same set view data as the previous request. For example, use N to get more rows of data from the same view.

Default: Y

Sorting control string

Generates an ORDER statement

Example: sort A.D&B.A
You can sort up to 4 parameters. A,B... are IDs from the get view definition request.

Generates a WHERE clause

Example: filter APPLID=CMF&SYSNAME=S*

Row from which to start the data retrieval

Default: 1

Maximum number of rows to return

Default: 200

(optional) Session token for retrieving more data for the same view as a previous data request

For more information, see Managing Common REST API session tokens and user tokens.

(optional) Parameter for indicating if a session will stay open or not.

For more information, see Managing Common REST API session tokens and user tokens.

productName

String

Product name

viewName

String

View name

context

String

system

String

Only if sent as a header parameter

server

String

Only if sent as a header parameter

Time

String

Time of the data

Startrow

Integer

1-based index of the first row of data

Rows

Integer

Total number of rows returned for this request

Totalrowcount

Integer

Total number of rows available

rc

Integer

Return code from the API

• 2 = rows
• 4 = data and messages
• 8 and greater = messages but no rows

rows

Array of row data

Each object in the rowdata array contains key-value pairs for the data. The key refers to the dataname property of the column in the view definition.

There may or may not be data in the rows array.

messages

Array of string

Messages from the host server

There may or may not be data in the messages array.

200

Successful completion

403

Unauthorized. The authorization token is missing, invalid or expired

404

The path is not valid. Most likely because the service in the URL does not exist.