Jump to

• Request
• Response
• Examples

Create Profile Extension

post

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

Request

Path Parameters

• listName: string
  List Name

Body ()

Request Body

Root 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

Response

Supported Media Types

• application/json

Default Response

Body ()

Root 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

A new profile extension table can be created for a given profile list by providing the schema of the profile extension table.

NOTE: When creating a new profile extension table, the supported field types are:

• STR500
• STR4000
• INTEGER
• NUMBER
• TIMESTAMP

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

Sample Request Body:

{
  "profileExtension": {
    "objectName": "ws_rest_petx",
    "folderName": "WS_REST_SAMPLE"
  },
  "fields": [
    {
      "fieldName": "edu",
      "fieldType": "STR500"
    }
  ]
}
	

Sample Response: Success

   True
	

Sample Response: Failure

    {
   		"type": "",
   		"title": "Folder not found",
   		"errorCode": "FOLDER_NOT_FOUND",
  		"detail": "WS_REST_SAMPLESS Folder Not Found",
   		"errorDetails": []
	}

     

Back to Top