Jump to

• Request
• Response
• Examples

Update Supplemental Table

put

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

Use this endpoint to update a supplemental table by providing the properties to update.

Request

Path Parameters

• folderName: string
  The name of the folder where the supplemental table is located.
• suppTableName: string
  The name of the supplemental table to update.

Body ()

Request Body

Root Schema : Update Supplemental Data Table Request

Type: object

Title: Update Supplemental Data Table Request

Show Source

• folderName: string
  The name of the folder where the supplemental table is located.
• tableName: string
  The name of the supplemental table to update.

{
    "title":"Update Supplemental Data Table Request",
    "type":"object",
    "properties":{
        "folderName":{
            "description":"The name of the folder where the supplemental table is located.",
            "type":"string"
        },
        "tableName":{
            "description":"The name of the supplemental table to update.",
            "type":"string"
        }
    },
    "required":[
        "folderName",
        "tableName"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Update Supplemental Data Table

Body ()

Root Schema : Update Supplemental Data Table Response

Type: object

Title: Update Supplemental Data Table Response

Show Source

• message: string
  Message: Supplemental Table has been updated will be displayed
• status: boolean
  true or false

{
    "title":"Update Supplemental Data Table Response",
    "type":"object",
    "properties":{
        "message":{
            "description":"Message: Supplemental Table has been updated will be displayed",
            "type":"string"
        },
        "status":{
            "description":"true or false",
            "type":"boolean"
        }
    },
    "required":[
        "message",
        "status"
    ]
}

Back to Top

Examples

Update a Supplemental table's properties.

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

Sample Request Body

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

Sample response: Success

{
  "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": []
}

Back to Top