Jump to

• Request
• Response

Fetch all the fields or the primary key fields of the custom table

get

/rest/api/v1.3/lists/{listName}/customTable/{tableName}

Request

Path Parameters

• listName: string
  List Name
• tableName: string
  Custom Table Name

Query Parameters

• ft(optional): string
  **ft=pk** returns only the primary key fields. **ft=all** returns all the fields. By default 'ft' is set to 'all'

Back to Top

Response

Supported Media Types

• application/json

Default Response

Custom Tables

Body ()

Root Schema : Custom Table Fields

Type: object

Title: Custom Table Fields

Show Source

• customTableData(optional): object customTableData
  Metadata about the custom table.
• fields(optional): array fields
  The Custom table Fields

{
    "title":"Custom Table Fields",
    "type":"object",
    "properties":{
        "fields":{
            "description":"The Custom table Fields",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "description":"The Custom data Field Name"
                    },
                    "fieldType":{
                        "type":"string",
                        "description":"The Custom data Field Type"
                    }
                }
            }
        },
        "customTableData":{
            "description":"Metadata about the custom table.",
            "type":"object",
            "properties":{
                "objectName":{
                    "description":"The name of Custom table",
                    "type":"string"
                },
                "listName":{
                    "description":"The name of list in which the Custom table exists",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : customTableData

Type: object

Metadata about the custom table.

Show Source

• listName(optional): string
  The name of list in which the Custom table exists
• objectName(optional): string
  The name of Custom table

{
    "description":"Metadata about the custom table.",
    "type":"object",
    "properties":{
        "objectName":{
            "description":"The name of Custom table",
            "type":"string"
        },
        "listName":{
            "description":"The name of list in which the Custom table exists",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: array

The Custom table Fields

Show Source

• Array of: object items

{
    "description":"The Custom table Fields",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "description":"The Custom data Field Name"
            },
            "fieldType":{
                "type":"string",
                "description":"The Custom data Field Type"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldName(optional): string
  The Custom data Field Name
• fieldType(optional): string
  The Custom data Field Type

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

Back to Top