Viewpoint Sessions REST APIs | Supported Operations | Teradata Viewpoint - 17.10 - Supported Operations - Teradata Data Lab - Teradata Viewpoint

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide

Product
Teradata Data Lab
Teradata Viewpoint
Release Number
17.10
Release Date
October 2021
Content Type
Programming Reference
Publication ID
B035-2215-101K
Language
English (United States)
HTTP Method URL Parameters and Path Variables Description Response
GET /api/public/systems/{systemId}/sessions
Path Variable
  • systemId: The id of the system
Optional Parameters
  • timestamp: Timestamp at which sessions are requested. Default is current server time.
  • state: The state in which sessions are. Default is All.
  • perPage: Number of sessions to return per page. Any number less than 1 will be interpreted as ALL. Default is 100. Maximum is 500.
  • page: The page number to return. Default is 1.
  • showSql: Set to TRUE to display the SQL text of each session.
Returns a list of all the sessions on a given Teradata system A list of sessions
GET /api/public/systems/{systemId}/sessions/{sessionNo}
Required Parameters
  • systemId: The id of the system
  • sessionNo: The number of the session
Optional Parameter
  • timestamp: Timestamp at which session details are requested. Default value is current server time.
  • showSql: Set to TRUE to display the SQL text of the session.
Returns information for the specified session number Details of a session