Retrieve Supplemental Table member based on a query attribute

This interface is to retrieve Supplemental Table Records by specifying the primary key values using the request parameters.

Note:
  • The total length of the string passed in for the fs parameter (containing the comma separated field names) cannot exceed 150 characters.
  • To retrieve values of all columns, you can specify only one field with value set to all (if you have a column called all, you should use two or more specific column names to avoid getting all of the columns).

Service URL:

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

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Request Parameters:

  • qa– Query Attribute. All of the Primary Key values of the Supplemental Table must be specified by repeating this parameter.
  • fs– Comma separated list of field names or ‘all’
  • id– IDs corresponding to the query attribute. All the Primary Key Values of the Supplemental Table must be specified by repeating this parameter. The order of the values must match the order of the Primary Keys specified in the qa parameter.

Request Body:

None

Sample Request:

/rest/api/v1.3/folders/DemoNewsLetter/suppData/CompositePKSuppTable/members?qa=PK1&qa=PK2&qa=PK3&fs=PK1,PK2,PK3,F1,F2&id=1&id=1&id=1

Sample Response in case of success:

Note: Other attributes in the response, such as mapTemplateName, insertOnNoMatch, updateOnMatch, and matchColumn, will have default values (null/false).

{  
    "recordData":{  
        "fieldNames":[  
            "PK1",
            "PK2",
            "PK3",
            "F1",
            "F2"
        ],
        "records":[  
        [  
                "1",
                "1",
                "1",
                "onerec",
                "onecol"
         ]
        ],
        "mapTemplateName":null
    },
    "insertOnNoMatch":false,
    "updateOnMatch":null,
    "links":[  
        {  
            "rel":"self",
            "href":"/rest/api/v1.3/folders/DemoNewsLetter/suppData/CompositePKSuppTable/members?qa=PK1&qa=PK2&qa=PK3&fs=PK1,PK2,PK3,F1,F2&id=1&id=1&id=1",
            "method":"GET"
        },
        {  
            "rel":"mergeTableMembers",
            "href":"/rest/api/v1.3/folders/DemoNewsLetter/suppData/CompositePKSuppTable/members",
            "method":"POST"
        }
    ]
}

Sample Response in case of failure:

{
   "type": "",
   "title": "Invalid field name",
   "errorCode": "INVALID_FIELD_NAME",
   "detail": "Column(s) [F1] is not indexed",
   "errorDetails": []
}

Sample Response in case not ALL Primary Key Columns are specified in the qa request parameter:

{
   "type": "",
   "title": "Invalid request parameters",
   "errorCode": "INVALID_PARAMETER",
   "detail": "All and Only the Primary Keys in the Table [PK1, PK2, PK3] must be specified as Query Columns.",
   "errorDetails": []
}