Data Lab REST APIs | Data Objects | Teradata Viewpoint - Data Objects - 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
Create lab group return status
{
     "success":true
     "groupid":100
     "cancel":false
} 
List lab groups (IncludePrivacyInfo=true)
[
        {
            "groupId":20,
            "name":"AnnualSales",
            "parentDB":"DBC",
            "isPrivate":false,
            "size":200000000,
            "allocated":10000000,
            "used":500000,
            "description":"This is a lab group for Annual Sales",
            "location":"labs_AnnualSales",
            "created":"2018-06-20T11:10:26Z",
            "privacyInfo": {
                "accessLimit": "INCLUDE",
                "users": [
                    "abc",
                    "adw",
                    "wlauser"
                ],
                "roles": [
                    "evenrole",
                    "oddrole"
                ]
            } 
        }, 
        {
            "groupId":41,
            "name":"Finance",
            "parentDB":"DBC",
            "isPrivate":true,
            "size":3600000000,
            "allocated":220000000,
            "used":1400000,
            "description":"This is a lab group for Finance",
            "location":"labs_Finance",
            "created":"2018-04-25T16:40:42Z",
            "privacyInfo": {
                "accessLimit": "EXCLUDE",
                "users": [
                    "All",
                    "abc",
                    "abortuser",
                    "adw"
                ],
                "roles": [
                    "PDCR_Access",
                    "PDCR_Admin",
                    "PDCR_Canary"
                ]
            }
        }
]
List lab group owners
[
        {
            "name":"admin",
            "isRole":false
        },
        {
            "name":"dlgown004"
            "isRole":true
        }
]
List labs
[
    {
      "labId": 225,
      "labName": "Lab1",
      "creationDate": "2021-06-28T14:26:00.021Z",
      "expirationDate": "2021-09-26T14:25:59.708Z",
      "groupId": 123,
      "notificationExpiration": 14,
      "notificationSpace": 10
    },
    {
      "labId": 226,
      "labName": "Lab2",

]
List lab owners
[
        {
            "name":"admin",
            "isRole":false
        },
        {
            "name":"dlgown004"
            "isRole":true
        }
]
List request log (log=true)
[
    {
      "logId": 247,
      "requestId": 139,
      "action": "REQUEST",
      "systemName": "Almond",
      "requestType": "ADD_LAB",
      "logDate": "2018-07-27 09:02:45.096",
      "groupName": "Guild",
      "labName": "Edric",
      "location": "Edric",
      "isAutomaticApproval": false,
      "approver": "admin",
      "requestor": "ss185026",
      "additionalInfo": {
        "expires": "2018-10-25 09:02:45.091",
        "size": 1048576
    },
    {
      "logId": 190,
      "requestId": 108,
      "action": "EXECUTION",
      "systemName": "Almond",
      "requestType": "NEW_LAB_GROUP",
      "logDate": "2018-07-26 16:39:55.572",
      "status": "FAILED",
      "groupName": "Bachelor",
      "location": "labs_Bachelor",
      "isAutomaticApproval": true,
      "requestor": "admin",
      "error": "Step failed: Create lab group user Bachelor.  [Teradata Database] [TeraJDBC 16.20.00.01] [Error 5612] [SQLState HY000] A user, database, role, or zone with the specified name already exists."
    }
]