Update a supplemental table

Use this interface to update a supplemental table by providing the table properties to update. You can update a supplemental table's name and folder name.

Service URL:

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

Required Path Parameters:

  • folderName - The name of the folder where the supplemental table is located

  • suppTableName - The name of the supplemental table to update.

Request Method:

PUT

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Sample Request Body:

{
  "folderName": "Folder_1",
  "tableName": "Supp_Table_1"
}

Response if successful:

{
  "message": "Supplemental Table has been updated",
  "status": true
}

Sample Failure Responses:

If a supplemental table with the same name in the specified folder already exists:

{
  "type": "",
  "title": "Table already exists",
  "errorCode": "TABLE_ALREADY_EXISTS",
  "detail": "Supplemental Table for given name [Supp_Table1 ] already exists in folder [Folder1]",
  "errorDetails": []
}

If an invalid character is specified for the supplemental table name:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid characters in the Table Name",
  "errorDetails": []
}

If an invalid character is specified for the folder name:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Invalid characters in the Folder Name",
  "errorDetails": []
}

If more than 100 characters are specified for the folder name:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Max Length of folder name allowed: 100",
  "errorDetails": []
}

If more than 100 characters are specified for the supplemental table name:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Max Length of table name allowed: 100",
  "errorDetails": []
}

If the folder name specified does not exist:

{
  "type": "",
  "title": "Folder not found",
  "errorCode": "FOLDER_NOT_FOUND",
  "detail": "Folder name [Folder1] does not exist",
  "errorDetails": []
}

If the supplemental table name specified does not exist:

{
  "type": "",
  "title": "Table not found",
  "errorCode": "TABLE_NOT_FOUND",
  "detail": "No Supplemental Table found for given name [Supp_Table1 ]",
  "errorDetails": []
}

If the folder name in the request payload does not exist:

{
  "type": "",
  "title": "Folder not found",
  "errorCode": "FOLDER_NOT_FOUND",
  "detail": "Folder name [Folder1] does not exist",
  "errorDetails": []
}

If in the request URL the supplemental table name specified is found, but the folder name is not found: 

{
  "type": "",
  "title": "Table not found",
  "errorCode": "TABLE_NOT_FOUND",
  "detail": "No Supplemental Table found for given name [mySupplementalTable ]",
  "errorDetails": []
}

Learn more

REST API v1.3 resources