Jump to

• Request
• Response
• Examples

Create Supplemental Table

post

/rest/api/v1.3/folders/{folderName}/suppData

Use this endpoint to create a new supplemental table by providing its schema.

Request

Path Parameters

• folderName: string
  Folder Name

Body ()

Request Body

Root Schema : create supplemental table Request

Type: object

Title: create supplemental table Request

Show Source

• primaryKeys(optional): array primaryKeys
  Array of primary keys corresponding to the supplemental table.
• records(optional): array records
  Array of columns corresponding to the supplemental table.
• table(optional): object table
  Supplemental table name

{
    "title":"create supplemental table Request",
    "type":"object",
    "properties":{
        "table":{
            "description":"Supplemental table name",
            "type":"object",
            "properties":{
                "objectName":{
                    "type":"string",
                    "description":"Name of the supplemental table"
                }
            }
        },
        "records":{
            "description":"Array of columns corresponding to the supplemental table. ",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "description":"The supplemental table Field Name"
                    },
                    "fieldType":{
                        "type":"string",
                        "description":"The supplemental table Field Type"
                    },
                    "dataExtractionKey":{
                        "type":"boolean",
                        "description":"Data Extraction Key column of the supplemental table"
                    }
                }
            }
        },
        "primaryKeys":{
            "description":"Array of primary keys corresponding to the supplemental table.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : primaryKeys

Type: array

Array of primary keys corresponding to the supplemental table.

Show Source

• Array of: string

{
    "description":"Array of primary keys corresponding to the supplemental table.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : records

Type: array

Array of columns corresponding to the supplemental table.

Show Source

• Array of: object items

{
    "description":"Array of columns corresponding to the supplemental table. ",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "description":"The supplemental table Field Name"
            },
            "fieldType":{
                "type":"string",
                "description":"The supplemental table Field Type"
            },
            "dataExtractionKey":{
                "type":"boolean",
                "description":"Data Extraction Key column of the supplemental table"
            }
        }
    }
}

Nested Schema : table

Type: object

Supplemental table name

Show Source

• objectName(optional): string
  Name of the supplemental table

{
    "description":"Supplemental table name",
    "type":"object",
    "properties":{
        "objectName":{
            "type":"string",
            "description":"Name of the supplemental table"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dataExtractionKey(optional): boolean
  Data Extraction Key column of the supplemental table
• fieldName(optional): string
  The supplemental table Field Name
• fieldType(optional): string
  The supplemental table Field Type

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The supplemental table Field Name"
        },
        "fieldType":{
            "type":"string",
            "description":"The supplemental table Field Type"
        },
        "dataExtractionKey":{
            "type":"boolean",
            "description":"Data Extraction Key column of the supplemental table"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

true/false indicating success or failure.

Body ()

Root Schema : create supplemental table Response

Type: boolean

Title: create supplemental table Response

true/false indicating success or failure.

Back to Top

Examples

The following example shows how to create a new supplemental table.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Content-Type	application/json

Sample Request:

    /rest/api/v1.3/folders/<folderName>/suppData
	

Sample Request Body:

       {
        "table" : {"objectName": "WS_REST_SUPPDATA_NEW"},
        "fields" : [
         {
            "fieldName":"edu", 
            "fieldType" : "STR500",
            "dataExtractionKey" : false
          },
          {
            "fieldName":"uni", 
            "fieldType" : "STR500",
            "dataExtractionKey" : false
          },
          {
            "fieldName":"grade", 
            "fieldType" : "STR500",
            "dataExtractionKey" : false
          }
        ],
        "primaryKeys" : ["edu"]
      }

   

Sample Response: Failure

     {
      "type": "",
       "title": "Invalid request parameters",
       "errorCode": "INVALID_PARAMETER",
       "detail": "Create Table Without PK is not supported.Please include Primary Key.",
       "errorDetails": []
      } 
	

Back to Top