FormInstance Endpoint

PUT /forminstance/{id}/relateform

#!/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"]') # script to relate a form instance to another form instance # must use ?relateToId=formId or ?relateTodocId=docId curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ -d '{ }' \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/forminstance/{id}/relateform?relatetoid={id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "PUT",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/forminstance/a6aae3c1-e16d-e511-80d0-0050568dfc50/relateform?relatetoid=eb7aea47-e06d-e511-80d0-0050568d3d8b"
  }
}
Relates a form instance to another form instance by Form Instance Id. The first Id is the form instance that will be related to the second Form Instance 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 Form Instance Id
password string Password from Visual Vault
userName string User Name from Visual Vault

PUT /forminstance/{id}/relatedocument

#!/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"]') # script to relate a form instance to a document # must use ?relatetoid=Id or ?relatetoid=docId curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ -d '{ }' \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/forminstance/{id}/relatedocument?relatetoid={id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "PUT",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/forminstance/a6aae3c1-e16d-e511-80d0-0050568dfc50/relateDocument?relatetoid=e1de9a71-d26d-e511-80d0-0050568dfc50"
  }
}
Relates a form instance to a document by Form Instance Id and Document Revision Id. The first Id is the Form Instance Id of the form. The second Id is the Document Revision Id being related to the form.
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 Form Instance Id
id guid Document Revision Id
password string Password from Visual Vault
userName string User Name from Visual Vault

PUT /forminstance/{id}/relateproject

#!/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"]') # script to relate a form instance to a Project # must use ?relateToId=projectId curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ -d '{ }' \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/forminstance/{id}/relateproject?relatetoid={id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "PUT",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/forminstance/a6aae3c1-e16d-e511-80d0-0050568dfc50/relateProject?relatetoid=cae8d65f-7b77-e511-80d0-0050568dfc50"
  }
}
Relates a form instance to a Project by Form Instance Id and Project Id. The first Id is the Form Instance Id and the second Id is the Project 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 Form Instance Id
id guid Project Id
password string Password from Visual Vault
userName string User Name from Visual Vault

PUT /forminstance/{id}/unrelateform

#!/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"]') # script to unrelate a form instance from another form instance # must use ?relateToId=formId or ?relateTodocId=docId curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ -d '{ }' \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/forminstance/{id}/unrelateform?relatetoid={id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "PUT",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/forminstance/a6aae3c1-e16d-e511-80d0-0050568dfc50/unrelateform?relatetoid=eb7aea47-e06d-e511-80d0-0050568d3d8b"
  }
}
Unrelates a form instance from another form instance by Form Instance Id. The first Id is the form instance that will be unrelated from the second Form Instance 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 Form Instance Id
password string Password from Visual Vault
userName string User Name from Visual Vault

PUT /forminstance/{id}/unrelatedocument

#!/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"]') # script to unrelate a form instance from a document # must use ?relatetoid=Id or ?relatetoid=docId curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ -d '{ }' \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/forminstance/{id}/unrelatedocument?relatetoid={id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "PUT",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/forminstance/a6aae3c1-e16d-e511-80d0-0050568dfc50/unrelateDocument?relatetoid=e1de9a71-d26d-e511-80d0-0050568dfc50"
  }
}
Unrelates a form instance from a document by Form Instance Id and Document Revision Id. The first Id is the Form Instance Id of the form. The second Id is the Document Revision Id being unrelated to the form.
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 Form Instance Id
id guid Document Revision Id
password string Password from Visual Vault
userName string User Name from Visual Vault

PUT /forminstance/{id}/unrelateproject

#!/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"]') # script to unrelate a form instance from a Project # must use ?relateToId=projectId curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AccessToken" \ -d '{ }' \ https://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/forminstance/{id}/unrelateproject?relatetoid={id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "PUT",
    "href": "https://demo.visualvault.com/api/v1/{customerAlias}/default/forminstance/a6aae3c1-e16d-e511-80d0-0050568dfc50/unrelateProject?relatetoid=cae8d65f-7b77-e511-80d0-0050568dfc50"
  }
}
Unrelates a form instance from a project by Form Instance Id and Project Id. The first Id is the Form Instance Id and the second Id is the Project 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 Form Instance Id
id guid Project Id
password string Password from Visual Vault
userName string User Name from Visual Vault