PersistedData Endpoint

DELETE /persistedData/{id}

#!/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 delete an instance of persisted data by id and using token as a variable named AccessToken curl -X DELETE \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/persistedData/{id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "DELETE",
    "href": "https://demo.visualvault.com/api/v1/mycustomer/mydatabase/persistedData/74b5dc0c-fedc-4406-8a69-a5087e707ab5"
  },
  "data": {
    "success": true
  }
}
Deletes an instance of persisted data by Persisted Data Id.
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
id guid Persisted Data Id
password string Password from Visual Vault
userName string User Name from Visual Vault

GET /persistedData

#!/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 persisted data by using token as a variable named AccessToken # ?expand=data to expand all available fields from default fields curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/persisteddata?expand=data
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "GET",
    "href": "https://demo.visualvault.com/api/v1/testjones/default/persistedData/?expand=data"
  },
  "data": [
    {
      "href": "~/persistedData/74b5dc0c-fedc-4406-8a69-a5087e707ab5",
      "dataType": "PersistedData",
      "id": "74b5dc0c-fedc-4406-8a69-a5087e707ab5",
      "createByUsId": "5eefec33-ca71-e511-befe-98991b71acc0",
      "createDateUtc": "2015-10-22T15:01:18.257",
      "persistedData": "{\"invoice no\":\"272255\",\"formname\":\"orderform\",\"Address\":\"ds\"}",
      "dataLength": 61,
      "dataMimeType": "text/JSON",
      "expirationDateUtc": null,
      "linkedObjectId": "",
      "linkedObjectType": 0,
      "modifiedByUsId": "5eefec33-ca71-e511-befe-98991b71acc0",
      "modifiedDateUtc": "2015-10-22T15:01:18.257",
      "name": "XXAXWW6iZ06UEVbDe6wOXQ",
      "scope": 1
    }
  ],
  "pagination": {
    "dataType": "PagedData",
    "href": "",
    "first": "",
    "last": "",
    "limit": 200,
    "next": "",
    "previous": "",
    "totalRecords": 1
  }
}
Data Types: PersistedData
Requests all Persisted Data. If ?expand=data is appended to the url sring, than all available fields will be returned. If not, then just the default fields will be returned. May use optional query string parameter here.
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 /persistedData/{id}

#!/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 persisted data by using token as a variable named AccessToken # ?expand=data to expand all available fields from default fields curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/persistedData/{id}?expand=data
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "GET",
    "href": "https://demo.visualvault.com/api/v1/testjones/default/persistedData/74b5dc0c-fedc-4406-8a69-a5087e707ab5?expand=data"
  },
  "data": {
    "href": "~/persistedData/74b5dc0c-fedc-4406-8a69-a5087e707ab5",
    "dataType": "PersistedData",
    "id": "74b5dc0c-fedc-4406-8a69-a5087e707ab5",
    "createByUsId": "5eefec33-ca71-e511-befe-98991b71acc0",
    "createDateUtc": "2015-10-22T15:01:18.257",
    "persistedData": "{\"invoice no\":\"272255\",\"formname\":\"orderform\",\"Address\":\"ds\"}",
    "dataLength": 61,
    "dataMimeType": "text/JSON",
    "expirationDateUtc": null,
    "linkedObjectId": "",
    "linkedObjectType": 0,
    "modifiedByUsId": "5eefec33-ca71-e511-befe-98991b71acc0",
    "modifiedDateUtc": "2015-10-22T15:01:18.257",
    "name": "XXAXWW6iZ06UEVbDe6wOXQ",
    "scope": 1
  }
}
Data Types: PersistedData
Requests an instance of persisted data by Persisted Data Id. If ?expand=data is appended to the url sring, than all available fields will be returned. If not, then just the default fields will be returned.
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
id guid Persisted Data Id
password string Password from Visual Vault
userName string User Name from Visual Vault

POST /persistedData

#!/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 create an instance of persisted data by using token as a variable named AccessToken curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ -d '{ "name": "XXAXWW6iZ06UEVbDe6wOXQ", "scope": 1, "persistedData": "{\"invoice no\":\"272255\",\"formname\":\"orderform\",\"Address\":\"ds\"}", "dataMimeType": "text/JSON", "linkedObjectId": "", "linkedObjectType": 0, "expirationDateUtc": null }' \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/persistedData/
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "POST",
    "href": "https://demo.visualvault.com/api/v1/testjones/default/PersistedData/"
  },
  "data": {
    "href": "~/persistedData/74b5dc0c-fedc-4406-8a69-a5087e707ab5",
    "dataType": "PersistedData",
    "id": "74b5dc0c-fedc-4406-8a69-a5087e707ab5",
    "createByUsId": "5eefec33-ca71-e511-befe-98991b71acc0",
    "createDateUtc": "2015-10-22T15:01:18.257",
    "persistedData": "{\"invoice no\":\"272255\",\"formname\":\"orderform\",\"Address\":\"ds\"}",
    "dataLength": 61,
    "dataMimeType": "text/JSON",
    "expirationDateUtc": null,
    "linkedObjectId": "",
    "linkedObjectType": 0,
    "modifiedByUsId": "5eefec33-ca71-e511-befe-98991b71acc0",
    "modifiedDateUtc": "2015-10-22T15:01:18.257",
    "name": "XXAXWW6iZ06UEVbDe6wOXQ",
    "scope": 1
  }
}
Data Types: PersistedData
Creates an instance of persisted data. Persisted data is a dictionary of name & value pairs which can be referenced in a VisualVault Web application request query string. When you create a Persisted Data dictionary object an id value (guid) is returned. For example: ./formdetails?formid={guid}&PersistedId={guid} will populate a VisualVault Form with dictionary values where the Form Field names match the Persisted Data Dictionary Keys.
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