Meta Endpoint

GET /meta

#!/bin/sh # script to get token AccessToken=$(curl -X POST -d "client_id={clientId}&client_secret={clientSecret}&username={userName}&password={password}&grant_type=password" \ https://demo.visualvault.com/oauth/token | python -c 'import sys, json; print json.load(sys.stdin)["access_token"]') # run command to request a list of all datatypes by using token as a variable named AccessToken curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/meta
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "GET",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/meta/"
  },
  "data": {
    "dataTypes": [
      "Customer",
      "CustomerDatabase",
      "CustomerDatabase",
      "Document",
      "DocumentIndexField",
      "Folder",
      "FolderIndexField",
      "FormInstance",
      "FormTemplate",
      "Group",
      "IndexFieldDefinition",
      "IndexFieldSelectOption",
      "PersistedData",
      "ServerStatus",
      "Site",
      "User"
    ]
  }
}
Requests a list of all datatypes.
Parameters
Key Type Description
clientId guid Client Id from Visual Vault
clientSecret guid Client Secret from Visual Vault
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
password string Password from Visual Vault
userName string User Name from Visual Vault

GET /meta/{datatype}

#!/bin/sh # script to get token AccessToken=$(curl -X POST -d "client_id={clientId}&client_secret={clientSecret}&username={userName}&password={password}&grant_type=password" \ https://demo.visualvault.com/oauth/token | python -c 'import sys, json; print json.load(sys.stdin)["access_token"]') # run command to request a list of all datatypes by using token as a variable named AccessToken curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/meta/{datatype}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "GET",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/meta/Customer/"
  },
  "data": {
    "dataType": "Customer",
    "availableFields": [
      "ActiveUsers",
      "Alias",
      "Description",
      "Enabled",
      "Id",
      "InactiveUsers",
      "Name",
      "Notes",
      "TimeZone"
    ],
    "defaultFields": [
      "Alias",
      "Id",
      "Name"
    ],
    "idField": "Id"
  }
}
Data Types: Customer
Requests a list of fields for a given DataType.
Parameters
Key Type Description
clientId guid Client Id from Visual Vault
clientSecret guid Client Secret from Visual Vault
customeralias string The alias of the customer you want to connect to
databasealias string The alias of the database of the customer you want to connect to
datatype string The name of the DataType
password string Password from Visual Vault
userName string User Name from Visual Vault