PingOne Platform APIs

Update DaVinci Variable

 

PUT {{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}

The PUT {{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}} operation updates the DaVinci variable resource specified by its ID in the request URL.

Request Model
Property Type Required?

context

String

Required

dataType

String

Required

displayName

String

Optional

flow

Object

Optional

flow.id

String

Optional

max

Integer

Optional

min

Integer

Optional

mutable

Boolean

Optional

name

String

Required

value

String

Optional

Refer to DaVinci Admin Variables data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "restore",
    "dataType": "string",
    "context": "flowInstance",
    "mutable": true,
    "min": 0,
    "max": 200
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "restore",
    "dataType": "string",
    "context": "flowInstance",
    "mutable": true,
    "min": 0,
    "max": 200
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""name"": ""restore""," + "\n" +
@"    ""dataType"": ""string""," + "\n" +
@"    ""context"": ""flowInstance""," + "\n" +
@"    ""mutable"": true," + "\n" +
@"    ""min"": 0," + "\n" +
@"    ""max"": 200" + "\n" +
@"}                ";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}"
  method := "PUT"

  payload := strings.NewReader(`{
    "name": "restore",
    "dataType": "string",
    "context": "flowInstance",
    "mutable": true,
    "min": 0,
    "max": 200
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
PUT /environments/{{envID}}/variables/{{davinciVariableID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "name": "restore",
    "dataType": "string",
    "context": "flowInstance",
    "mutable": true,
    "min": 0,
    "max": 200
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"restore\",\n    \"dataType\": \"string\",\n    \"context\": \"flowInstance\",\n    \"mutable\": true,\n    \"min\": 0,\n    \"max\": 200\n}                ");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "restore",
    "dataType": "string",
    "context": "flowInstance",
    "mutable": true,
    "min": 0,
    "max": 200
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "restore",
    "dataType": "string",
    "context": "flowInstance",
    "mutable": true,
    "min": 0,
    "max": 200
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}"

payload = json.dumps({
  "name": "restore",
  "dataType": "string",
  "context": "flowInstance",
  "mutable": True,
  "min": 0,
  "max": 200
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "name": "restore",\n    "dataType": "string",\n    "context": "flowInstance",\n    "mutable": true,\n    "min": 0,\n    "max": 200\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "restore",
  "dataType": "string",
  "context": "flowInstance",
  "mutable": true,
  "min": 0,
  "max": 200
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"restore\",\n    \"dataType\": \"string\",\n    \"context\": \"flowInstance\",\n    \"mutable\": true,\n    \"min\": 0,\n    \"max\": 200\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/variables/{{davinciVariableID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/variables/90bd6871-58ff-455e-a48d-77923fd299cd"
        }
    },
    "id": "90bd6871-58ff-455e-a48d-77923fd299cd",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "continue",
    "dataType": "string",
    "context": "flowInstance",
    "mutable": true,
    "min": 0,
    "max": 200,
    "createdAt": "2024-05-06T22:34:13.422Z",
    "updatedAt": "2024-05-06T22:37:19.973Z"
}