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

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide
Product
Teradata Data Lab
Teradata Viewpoint
Release Number
16.50
16.20
Published
July 2021
Language
English (United States)
Last Update
2021-07-27
dita:mapPath
prd1525780132746.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-2215
lifecycle
previous
Product Category
Analytical Ecosystem
HTTP URL Parameters Description Response
POST /api/public/dataLabs/systems/{systemId}/groups
Path Variable
  • systemId: The id of the system
Required Parameters
  • groupName: Specifies the group name
  • parentDatabase: Specifies parent database for the lab group
  • labGroupSize: Allocated space for the lab group in bytes (min: 1, max: 9999
  • defaultLabSize: Default size for all labs under this lab group
    If defaultLabSize > labGroupSize, a 403 error response will be returned.
Optional Parameters
  • description: Description of the lab group
  • spaceNotificationThreshold: When allocated space is within this percentage of the lab group size a notification is sent. Default: 10
  • enableDefaultLabExpiration; Default: true
  • defaultLabExpiration; Default: 90 (min: 1, max: 9999)
  • enableLimitExpirationDuration; Default: false
  • limitRequestExpirationDuration; Default: 365 (min: 1, max: 9999)
  • enableDaysBeforeExpiredLabDeletion; Default: false
  • daysBeforeExpiredLabDeletion; Default: 14 (min: 1, max: 9999)
  • labPrefix: id used to associate labs with one another (max length: 12 characters)
  • defaultLabNotificationExpiration; Default: 14
  • defaultLabNotificationSpace; Default: 10 (min: 1, max: 100)
  • enableCreateTable; Default: true
  • owners: List of owners who have access to this lab group (specified by their Viewpoint username)
 Creates and configures a data lab group Indicates whether lab group was created successfully, and group information
GET /api/public/dataLabs/systems/{systemId}/groups
Path Variable
  • systemId: The id of the system
Optional Parameters
  • name: Name of the lab group
  • includePrivacyInfo: Determines whether the response body includes detailed privacy information for the lab groups.
  • perPage: Number of lab groups to return per page. Default: 100 (range: 1 - 500)
  • page: The page number to return. Default: 1
 Provides a list of all lab groups on the specified system List of lab groups
GET /api/public/dataLabs/systems/{systemId}/groups/{groupId}/owners Path Variables
  • systemId: The id of the system
  • groupId: The id of the lab group
 Gets the owners of a lab group When successful, indicates lab group owners
POST /api/public/dataLabs/systems/{systemId}/groups/{groupid}/requests/add
Path Variables
  • systemId: The id of the system
  • groupId: The id of the lab group to which the lab request will be sent
Required Parameter
  • labName - name of lab
Optional Parameters
  • description: Description of the lab
  • labSize: Size of lab (if not set, the size is set to defaultLabSize, which is set during lab group creation)
  • labNotificationSpace: When allocated space is within this percentage of the lab size a notification is sent. Default: 10
 Creates and configures a data lab Indicates whether lab was successfully created
GET /api/public/dataLabs/systems/{systemId}/groups/{groupId}/labs
Path Variables
  • systemId: The id of the system
  • groupId: The id of the lab group to which the lab request will be sent
Optional Parameters
  • labName: Name of the lab
  • labNameMatch:If true, the full name provided under "labName" is matched. If false, labs starting with the name provided under "labName" is matched
  • perPage: Number of lab groups to return per page. Default: 100. Range: (1 - 500)
  • page: The page number to return to. Default: 1
 Provides a list of labs under a lab group List of labs in a lab group
GET /api/public/dataLabs/systems/{systemId}/groups/{groupId}/labs/{labid}/owners Path Variables
  • systemId: The id of the system
  • groupId: The id of the lab group
  • labId: The id of the lab
Provides a list of owners of a data lab When successful, indicates lab owners
POST /api/public/dataLabs/systems/{systemId}/groups/{groupId}/labs/{labid}/requests/delete Path Variables
  • systemId: The id of the system
  • groupId: The id of the lab group that the lab is part of
  • labId: The id of the lab being deleted
 Deletes a lab Indicates whether lab was successfully deleted
GET /api/public/dataLabs/systems/{systemId}/requests
Path Variable
  • systemId: The id of the system
Optional Parameters
  • groupName: Name of the lab group
  • log: A flag to obtain detailed system log. Default: false
  • requestType: Type of the request:
    • NEW_LAB_GROUP
    • UPDATE_LAB_GROUP
    • DELETE_LAB_GROUP
    • ADD_LAB
    • ADD_LAB_OWNER
    • ADD_LAB_USER_OR_ROLE
    • REMOVE_LAB_SPACE
    • DELETE_LAB
    • UPDATE_LAB
    • CHANGE_LAB_EXPIRATION
    • ADD_LAB_SPACE
    • REINSTATE_LAB
    • REMOVE_LAB_OWNER
    • REMOVE_LAB_USER_OR_ROLE
    • OTHER
  • perPage: Number of request objects to return per page. Default: 100 (range: 1 - 500)
  • page: The page number to return. Default: 1
Provides a list of requests information for the specified system List of request information