Scripts Endpoint

POST /scripts/

curl -X POST \ \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ -d '{ JSON Data }' http://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/scripts?name={name}&id={id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "POST",
    "href": "http://demo.visualvault.com/api/v1/mycustomer/mydatabase/scripts?name=myScript&token={accesstoken}"
  },
  "data": {
    "scriptDefinedJson1": "OUTPUT OF SCRIPT RESULTS HERE",
    "scriptDefinedJson2": "THIS STRUCTURE IS USER DEFINED",
    "thisIsDefinedInTheScript": "ANY JSON CAN GO HERE"
  }
}
Post JSON script to be processed by an outside process specified either by name or id. Note that any successful run of the script will result in a 200 OK status, event though this is a POST request.
Parameters
Key Type Description
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 (optional) ID of the script you want to run. If you supply an ID you do not need to supply a name.
name string (optional) Name of the script you want to run. If you supply a name you do not need to supply an ID.

POST /scripts/{id}

curl -X POST \ \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer -kAps8pYfASIvXxa7DReah6n8CS9nWOR6V5iAMiBEThE2QkDamviU9g6nv6B6iG-I6XlUPdwFT_Tdc8g5NoTCqiVPWE5aaFctFJjpLysqU8fWL4GKlN4Pj273tCdyCrXcffXtN0MK33gdvDZIsywWESQtAnsqtv6BwyaZWmpaTUXuN236e1knQrmUQRoGRkfD7F9PSi4174Sm4gR_yrrmEHOwc3pOXV823cSy9VL9IsWSFLNdgx-bj0T6HFooBX0ZnMMZ23zoT6t2T6qTVUOlBnjJXR1TREJGtBwKKu39wD-onXo' \ -d '{ JSON Data }' http://demo.visualvault.com/api/v1/{customeralias}/{databasealias}/scripts/{id}
{
  "meta": {
    "status": 200,
    "statusMsg": "OK",
    "method": "POST",
    "href": "http://demo.visualvault.com/api/v1/mycustomer/mydatabase/Scripts/3cda2543-a291-4509-8463-fb424c9b7eb4"
  },
  "data": {
    "scriptDefinedJson1": "OUTPUT OF SCRIPT RESULTS HERE",
    "scriptDefinedJson2": "THIS STRUCTURE IS USER DEFINED",
    "thisIsDefinedInTheScript": "ANY JSON CAN GO HERE"
  }
}
Post JSON script to be processed by an outside process specified by id. Note that any successful run of the script will result in a 200 OK status, event though this is a POST request.
Parameters
Key Type Description
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 ID of the script you want to run.