Jump to

• Request
• Response
• Examples

Fetch All Profile Extensions for a Profile List

get

/rest/api/v1.3/lists/{listName}/listExtensions

Request

Path Parameters

• listName: string
  List Name

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : List Extensions

Type: object

Title: List Extensions

Show Source

• items(optional): array items

{
    "title":"List Extensions",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/listExtensions"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Profile Extension
  Title: Profile Extension

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/listExtensions"
    }
}

Nested Schema : Profile Extension

Type: object

Title: Profile Extension

Show Source

• fields: array fields
  The Profile Extension Fields
• profileExtension: object profileExtension
  The Profile Extension Object

{
    "title":"Profile Extension",
    "type":"object",
    "properties":{
        "profileExtension":{
            "description":"The Profile Extension Object",
            "required":[
                "objectName",
                "folderName"
            ],
            "type":"object",
            "properties":{
                "objectName":{
                    "type":"string",
                    "description":"The name of the Profile Extension"
                },
                "folderName":{
                    "type":"string",
                    "description":"The name of the folder in which the Profile Extension exists"
                }
            }
        },
        "fields":{
            "description":"The Profile Extension Fields",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "description":"The Profile Extension Field Name"
                    },
                    "fieldType":{
                        "type":"string",
                        "description":"The Profile Extension Field Type"
                    }
                }
            }
        }
    },
    "required":[
        "profileExtension",
        "fields"
    ]
}

Nested Schema : fields

Type: array

The Profile Extension Fields

Show Source

• Array of: object items

{
    "description":"The Profile Extension Fields",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "description":"The Profile Extension Field Name"
            },
            "fieldType":{
                "type":"string",
                "description":"The Profile Extension Field Type"
            }
        }
    }
}

Nested Schema : profileExtension

Type: object

The Profile Extension Object

Show Source

• folderName: string
  The name of the folder in which the Profile Extension exists
• objectName: string
  The name of the Profile Extension

{
    "description":"The Profile Extension Object",
    "required":[
        "objectName",
        "folderName"
    ],
    "type":"object",
    "properties":{
        "objectName":{
            "type":"string",
            "description":"The name of the Profile Extension"
        },
        "folderName":{
            "type":"string",
            "description":"The name of the folder in which the Profile Extension exists"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldName(optional): string
  The Profile Extension Field Name
• fieldType(optional): string
  The Profile Extension Field Type

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The Profile Extension Field Name"
        },
        "fieldType":{
            "type":"string",
            "description":"The Profile Extension Field Type"
        }
    }
}

Back to Top

Examples

This interface is to retrieve all profile extension tables (PETs) associated with a given profile list table.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

Sample Response: Success

Note: The response is a collection of all PETs for the specified Profile List. Each of the individual objects in the collection represents a Profile Extension Object with a link "Create a Profile Extension" for the Profile List.

  [{
   "profileExtension":    {
      "objectName": "WS_Auto_RIPET",
      "folderName": "WS_Auto_RIFolder"
   },
   "fields":    [
      {
         "fieldName": "RIID_",
         "fieldType": "INTEGER"
      },
      {
         "fieldName": "ENAME",
         "fieldType": "STR500"
      },
      {
         "fieldName": "EMPID",
         "fieldType": "STR500"
      },
      {
         "fieldName": "CREATED_BY_LOAD_JOB_ID_",
         "fieldType": "INTEGER"
      },
      {
         "fieldName": "LAST_MOD_BY_LOAD_JOB_ID_",
         "fieldType": "INTEGER"
      },
      {
         "fieldName": "CREATED_DATE_",
         "fieldType": "TIMESTAMP"
      },
      {
         "fieldName": "MODIFIED_DATE_",
         "fieldType": "TIMESTAMP"
      },
      {
         "fieldName": "LAST_BULK_LOAD_ID_",
         "fieldType": "INTEGER"
      },
      {
         "fieldName": "EMAIL_SHA256_HASH_",
         "fieldType": "STR100"
      },
      {
         "fieldName": "EMAIL_ADDRESS_",
         "fieldType": "STR500"
      },
      {
         "fieldName": "CUSTOMER_ID_",
         "fieldType": "STR255"
      },
      {
         "fieldName": "EMAIL_PERMISSION_STATUS_",
         "fieldType": "CHAR"
      },
      {
         "fieldName": "EMAIL_MD5_HASH_",
         "fieldType": "STR50"
      },
      {
         "fieldName": "EMAIL_ISP_",
         "fieldType": "STR255"
      },
      {
         "fieldName": "EMAIL_FORMAT_",
         "fieldType": "CHAR"
      },
      {
         "fieldName": "EMAIL_DELIVERABILITY_STATUS_",
         "fieldType": "CHAR"
      },
      {
         "fieldName": "EMAIL_DOMAIN_",
         "fieldType": "STR255"
      }
   ],
   "links": [   {
      "rel": "createProfileExtensionTable",
      "href": "/rest/api/v1.3/lists/WS_Auto_RILIST/listExtensions",
      "method": "POST"
   }]
}]

	

Sample Response: Failure

    {
   "type": "",
   "title": "List not found",
   "errorCode": "LIST_NOT_FOUND",
   "detail": "WS_Auto_RILISTs is an invalid list.",
   "errorDetails": []
}


     

Back to Top