List user-defined type names (UDTs) (HTTP)
|
For details about additional languages, see: |
Gets the names of the user-defined types (UDTs) in a keyspace.
|
Ready to write code? See the examples for this method to get started. |
Result
Returns the names of the user-defined types as an unordered list of strings in the status.types field of the response.
Example response:
{
"status": {
"types": [
"address",
"social_media"
]
}
}Signature
Use the listTypes command.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"listTypes": {
"options": {
"explain": false
}
}
}'Parameters
| Name | Type | Summary |
|---|---|---|
|
|
Must be |
Examples
The following examples demonstrate how to list names of the user-defined types in a keyspace.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"listTypes": {
"options": {
"explain": false
}
}
}'