Jump to

• Request
• Response
• Examples

Retrieve Profile List Fields

get

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

Retrieves the fields for the specified profile list. In the request URL, specify the name of the profile list to retrieve. A successful response returns a list of the standard and custom fields for the list.

Refer to the Oracle Responsys Help Center for more information about the profile list fields returned in the response.

Request

Path Parameters

• listName: string
  List Name

Back to Top

Response

Supported Media Types

• application/json

Default Response

List Response

Body ()

Root Schema : Profile List Fields Response Model

Type: object

Title: Profile List Fields Response Model

Show Source

• fields: array fields
  The Profile List Fields
• folderName: string
  The name of the folder in which the Profile List exists
• name: string
  The name of the Profile List

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

Nested Schema : fields

Type: array

The Profile List Fields

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

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

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

Back to Top

Examples

The following example shows how to retrieve profile list fields for a profile list.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Accept	application/json

Sample Request URL

Retrieve all fields for the profile list named DemoProfileList:

    /rest/api/v1.3/lists/DemoProfileList/fields
	

Sample Response: Success

{
  "name": "DemoProfileList",
  "folderName": "Responsys_Folder",
  "fields": [
    {
      "fieldName": "RIID_",
      "fieldType": "INTEGER"
    },
    {
      "fieldName": "CREATED_SOURCE_IP_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "CUSTOMER_ID_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_ADDRESS_",
      "fieldType": "STR500"
    },
    {
      "fieldName": "EMAIL_DOMAIN_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_ISP_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_FORMAT_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "EMAIL_PERMISSION_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "EMAIL_DELIVERABILITY_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "EMAIL_PERMISSION_REASON_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_MD5_HASH_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "EMAIL_SHA256_HASH_",
      "fieldType": "STR100"
    },
    {
      "fieldName": "MOBILE_NUMBER_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "MOBILE_COUNTRY_",
      "fieldType": "STR25"
    },
    {
      "fieldName": "MOBILE_PERMISSION_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "MOBILE_DELIVERABILITY_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "MOBILE_PERMISSION_REASON_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "POSTAL_STREET_1_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "POSTAL_STREET_2_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "CITY_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "STATE_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "POSTAL_CODE_",
      "fieldType": "STR25"
    },
    {
      "fieldName": "COUNTRY_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "POSTAL_PERMISSION_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "POSTAL_DELIVERABILITY_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "POSTAL_PERMISSION_REASON_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "CREATED_DATE_",
      "fieldType": "TIMESTAMP"
    },
    {
      "fieldName": "MODIFIED_DATE_",
      "fieldType": "TIMESTAMP"
    }
  ]
}
	

Example Response Failures

404 Not Found Errors

List not found: Requests fail when the profile list name specified is not found in Responsys. The error resembles:

{
  "type": "",
  "title": "List not found",
  "errorCode": "LIST_NOT_FOUND",
  "detail": "invalidList List is not found",
  "errorDetails": []
}
     

400 Bad Request Errors

Invalid list name length: Requests fail if the name of the profile list specified exceeds 100 characters. The error resembles:

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

401 Unauthorized Errors

Insufficient access to the list: Requests fail if the user performing the request does not have access to the specified list. The list may belong to a different organization. The error resembles:

{
  "type": "",
  "title": "Insufficient access",
  "errorCode": "INSUFFICIENT_ACCESS",
  "detail": "User does not have access to the list",
  "errorDetails": []
}
     

401 Unauthorized Errors

Insufficient privileges to API: Requests fail if the user performing the request does not have the List Web Services Manager role. This role is required to perform this request. The error resembles:

{
  "type": "",
  "title": "Insufficient access",
  "errorCode": "INSUFFICIENT_ACCESS",
  "detail": "Insufficient privileges to invoke this API",
  "errorDetails": []
}
     

Back to Top