Jump to

• Request
• Response
• Examples

Retrieve Supplemental Table member based on a query attribute

get

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

Request

Supported Media Types

• application/x-www-form-urlencoded

Path Parameters

• folderName: string
  Folder name
• tableName: string
  Table name

Query Parameters

• fs: string
  Comma separated list of fields to retrieve or 'all'
• id: string
  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.
• qa: string
  Query attribute. All of the primary key values of the Supplemental Table must be specified by repeating this parameter.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Supplemental Table records

Type: object

Title: Supplemental Table records

Show Source

• insertOnNoMatch: boolean
  Specifies whether a member record should be inserted into the Supplemental Table if it does not already exist.
• matchColumnNames: array matchColumnNames
  The column names to be used to match the member record to the Supplemental Table records. Only used during the merge operation.
• recordData: object recordData
  Record data that represents field names and corresponding values for the member.
• updateOnMatch: string
  Allowed Values: [ "REPLACE_ALL", "NO_UPDATE" ]

  Specifies whether a member record should be updated in the Supplemental Table if it already exists.

{
    "title":"Supplemental Table records",
    "type":"object",
    "properties":{
        "recordData":{
            "description":"Record data that represents field names and corresponding values for the member.",
            "required":[
                "fieldNames",
                "records"
            ],
            "type":"object",
            "properties":{
                "fieldNames":{
                    "type":"array",
                    "description":"Field names in the Supplemental Table",
                    "items":{
                        "type":"string"
                    }
                },
                "records":{
                    "type":"array",
                    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
                    "items":{
                        "type":"array",
                        "description":"Field values for the member in the Supplemental Table",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "mapTemplateName":{
                    "type":"string",
                    "description":"The map template in Responsys that can be used to map field names of the Supplemental Table to column names."
                }
            }
        },
        "insertOnNoMatch":{
            "description":"Specifies whether a member record should be inserted into the Supplemental Table if it does not already exist.",
            "type":"boolean"
        },
        "updateOnMatch":{
            "description":"Specifies whether a member record should be updated in the Supplemental Table if it already exists.",
            "enum":[
                "REPLACE_ALL",
                "NO_UPDATE"
            ],
            "type":"string"
        },
        "matchColumnNames":{
            "description":"The column names to be used to match the member record to the Supplemental Table records. Only used during the merge operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "recordData",
        "insertOnNoMatch",
        "updateOnMatch",
        "matchColumnNames"
    ]
}

Nested Schema : matchColumnNames

Type: array

The column names to be used to match the member record to the Supplemental Table records. Only used during the merge operation.

Show Source

• Array of: string

{
    "description":"The column names to be used to match the member record to the Supplemental Table records. Only used during the merge operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : recordData

Type: object

Record data that represents field names and corresponding values for the member.

Show Source

• fieldNames: array fieldNames
  Field names in the Supplemental Table
• mapTemplateName(optional): string
  The map template in Responsys that can be used to map field names of the Supplemental Table to column names.
• records: array records
  Array of values corresponding to the fieldNames. Each element in the array represents a single member.

{
    "description":"Record data that represents field names and corresponding values for the member.",
    "required":[
        "fieldNames",
        "records"
    ],
    "type":"object",
    "properties":{
        "fieldNames":{
            "type":"array",
            "description":"Field names in the Supplemental Table",
            "items":{
                "type":"string"
            }
        },
        "records":{
            "type":"array",
            "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
            "items":{
                "type":"array",
                "description":"Field values for the member in the Supplemental Table",
                "items":{
                    "type":"string"
                }
            }
        },
        "mapTemplateName":{
            "type":"string",
            "description":"The map template in Responsys that can be used to map field names of the Supplemental Table to column names."
        }
    }
}

Nested Schema : fieldNames

Type: array

Field names in the Supplemental Table

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field names in the Supplemental Table",
    "items":{
        "type":"string"
    }
}

Nested Schema : records

Type: array

Array of values corresponding to the fieldNames. Each element in the array represents a single member.

Show Source

• Array of: array items
  Field values for the member in the Supplemental Table

{
    "type":"array",
    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
    "items":{
        "type":"array",
        "description":"Field values for the member in the Supplemental Table",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Field values for the member in the Supplemental Table

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field values for the member in the Supplemental Table",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

This interface is to retrieve Supplemental Table Records by specifying the primary key values using the request parameters. Please note that 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).

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

FIELDS	DESCRIPTION
qa	Query Attribute-All the Primary Keys 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.

Sample Request URL:

   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: Success

NOTE: Other attributes in the response like 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: 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": []
}




     

Back to Top