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

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide - 24.04
Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Lab
Teradata Viewpoint
Release Number
24.04
Published
April 2024
ft:locale
en-US
ft:lastEdition
2024-04-29
dita:mapPath
qko1711972084905.ditamap
dita:ditavalPath
ft:empty
dita:id
prd1525780132746
lifecycle
latest
Product Category
Analytical Ecosystem
HTTP URL Parameters Description Response
GET /api/public/data_labs/systems/{system_id}/reports
Path Variable
  • system_id: The id of the system
Required Parameters:
  • report_type: Type of report: USER, ROLE, GROUP
  • data: Data for which reports need to be generated (for multiple data use comma separated as a, b)
 Provides report for the mentioned types and data List reports for the data provided
POST /api/public/data_labs/systems/{system_id}/groups
Path Variable
  • system_id: The id of the system
Request Body
  • LabGroup
The following parameters are required in the request body:
  • group_name: Specifies the group name
  • parent_database: Specifies parent database for the lab group
  • lab_group_size: Allocated space for the lab group in bytes (min: 1, max: 9999)
  • default_lab_size: Default size for all labs under this lab group
    If default_lab_size > lab_group_size, a 403 error response returns.
 Creates and configures a data lab group Indicates whether lab group was created successfully, and group information
GET /api/public/data_labs/systems/{system_id}/groups
Path Variable
  • system_id: The id of the system
Optional Parameters
  • name: Name of the lab group
  • include_privacy_info: Determines whether the response body includes detailed privacy information for the lab groups.
  • per_page: 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
PUT

/api/public/data_labs/systems /{system_id}/groups /{group_id}
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the lab request will be sent
Request Body
  • LabGroup
The following parameters are required in the request body:
  • group_name: Specifies the group name
  • parent_database: Specifies parent database for the lab group
  • lab_group_size: Allocated space for the lab group in bytes (min: 1, max: 9999)
  • default_lab_size: Default size for all labs under this lab group
    If defaultLabSize > lab_group_size, a 403 error response returns.
 Updates the existing lab group Indicates whether update for lab group was done successfully
GET /api/public/data_labs/systems/{system_id}/groups/{group_id}/owners Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group
 Gets the owners of a lab group When successful, indicates lab group owners
POST /api/public/data_labs/systems/{system_id}/groups/{group_id}/requests/lab
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the lab request will be sent
Request Body
  • Lab
The following parameter is required in the request body:
  • lab_name: name of lab
 Creates and configures a data lab Indicates whether lab was successfully created
POST /api/public/data_labs/systems /{system_id}/groups/ {group_id}/lab/requests /update
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the lab request will be sent
  • lab_name: The lab name for which the update request will be sent
Request Body
  • Lab
 Updates the existing lab Indicates whether update request for lab was successfully sent
POST /api/public/data_labs/systems /{system_id}/groups /{group_id}/labs/ {lab_id}/requests /lab_size
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group which requested lab contains
  • lab_id: The id of the lab which size needs to be increased or decreased
Request Body
  • lab_sSize object
 To increase or decrease the lab size Indicates whether request sent for modification of lab size is successful or not
POST /api/public/data_labs/systems /{system_id}/groups/ {group_id}/labs/{lab_id}/ requests/extend_lab
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the extend lab request will be sent
  • lab_id: The id of the lab for which the extend lab request will be sent
Request Body
  • ExtentLab object
 Extend lab expiration date for lab Indicates whether extend request for lab sent successfully
GET /api/public/data_labs/systems/{system_id}/groups/{group_id}/labs
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the lab request will be sent
Optional Parameters
  • lab_name: Name of the lab
  • lab_name_match:If true, the full name provided under "lab_name" is matched. If false, labs starting with the name provided under "lab_name" is matched
  • per_page: 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/data_labs/systems/{system_id}/groups/{group_id}/labs/{lab_id}/owners Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group
  • lab_id: The id of the lab
Provides a list of owners of a data lab When successful, indicates lab owners
GET /api/public/data_labs/systems/{system_id}/groups/{group_id}/labs/{lab_id}/members Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group in which the lab is available
  • lab_id: The id of the lab
Provides a list of users and roles of a data lab When successful, indicates a list of members (users and roles)
POST /api/public/data_labs/systems/{system_id}/groups/{group_id}/labs/{lab_id}/requests/delete Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group that the lab is part of
  • lab_id: The id of the lab being deleted
 Deletes a lab Indicates whether lab was successfully deleted
POST /api/public/data_labs/systems/{system_id}/groups/{group_id}/labs/{lab_id}/requests/lab_user
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group that the lab is part of
  • lab_id: The id of the lab being modified
Required Parameter
  • request_type: The type of request:
    • ADD
    • REMOVE
  • request Body
    • LabUsersAndRoles
 Add or remove users/roles to a lab Indicates whether the request for addition or removal of user/roles was successfully submitted
POST /api/public/data_labs/systems/{system_id}/groups/{group_id}/labs/{lab_id}/requests/lab_owner
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group that the lab is part of
  • lab_id: The id of the lab being modified
Required Parameter
  • request_type: The type of request:
    • ADD
    • REMOVE
  • request Body
    • LabOwner
 Add or remove lab owners Indicates whether the request for addition or removal of lab owners was successfully submitted
GET /api/public/data_labs/systems/{system_id}/requests
Path Variable
  • system_id: The id of the system
Optional Parameters
  • group_name: Name of the lab group
  • log: A flag to obtain detailed system log. Default: false
  • request_type: 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
  • per_page: 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
GET /api/public/data_labs/systems /{system_id}/groups/ {group_id}/permissions
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the permissions request will be sent
 Gets the permissions of a lab group Permissions of a lab group
GET /api/public/data_labs/systems /{system_id}/ groups/{group_id} /approval_policy_rules
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the approval policy rules request will be sent
 Gets the approval policy rules of a lab group List of approval policy rules of a lab group
POST

/api/public/data_labs/systems /{system_id}/groups/

{group_id}/labs/{lab_id}/ requests/reinstate_lab
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group to which the reinstate lab request will be sent
  • lab_id: The lab id for which the reinstate lab request will be sent
Request Body:
  • ReinstateLab object
 To reinstate lab for expired labs Indicates whether reinstate request for lab was sent successfully
POST /api/public/data_labs/systems /{system_id}/groups/ {group_id}/labs/{lab_id}/ requests/drop_object
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group that the lab is part of
  • lab_id: The id of the lab for which the object is to be dropped
Required Parameter
  • tablekind: The table kind (A, B, C, D, E, F, G, H, I, J, L, M, N, O, P, Q, R, S, T, U, V, X, Y, Z)
Request Body:
  • Drop Object
 Drop the object from the lab Indicates whether the drop request for the lab was successfully submitted
POST /api/public/data_labs/systems /{system_id}/groups/ {group_id}/labs/{lab_id}/ requests/approval
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group that the lab is part of
  • lab_id: The id of the lab for which the object is to be dropped
Required Parameter
  • requestId: The id of the request for which the approval/deny is to be performed
  • approval: Approve/Deny option to be chosen to approve/deny the request
Optional Parameter
  • denyComment
 Approve or deny lab requests Indicates whether the approve/deny request for the lab was successfully submitted
DELETE /api/public/data_labs/systems /{system_id}/groups /{group_id}
Path Variables
  • system_id: The id of the system
  • group_id: The id of the lab group requested to delete
 To delete a lab group Indicates whether lab group is successfully deleted or not