PingOne Platform APIs - Early Access

Update Promotion

 

PATCH {{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}

Use the PATCH {{apiPath}}/environments/{{envID}}/promotions{{promotionID}} request to update the promotion details for the specified promotion. The request body can contain only description, resourceMapping, and selectedResources. The target environment cannot be changed, so is not needed in the request body.

Request Model

For complete property descriptions, refer to Promotions.

Property Type Required?

description

String

Optional

excludedResources

Object[]*

Optional

resourceMapping

Map

Optional

selectedResources

Object[]*

Optional

sourceEnvironment

String

Optional

targetEnvironment

Object

Required

sourceSnapshotId

String

Optional

targetSnapshotId

String

Optional

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "resourceMapping": {"{{sourcePopulationsResource}}":"{{targetPopulationsResource}}"},
    "description": "Add population mapping"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PATCH '{{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "resourceMapping": {"{{sourcePopulationsResource}}":"{{targetPopulationsResource}}"},
    "description": "Add population mapping"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Patch);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""resourceMapping"": {""{{sourcePopulationsResource}}"":""{{targetPopulationsResource}}""}," + "\n" +
@"    ""description"": ""Add population mapping""" + "\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}}/promotions/{{promotionID}}"
  method := "PATCH"

  payload := strings.NewReader(`{
    "resourceMapping": {"{{sourcePopulationsResource}}":"{{targetPopulationsResource}}"},
    "description": "Add population mapping"
}`)

  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))
}
PATCH /environments/{{envID}}/promotions/{{promotionID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "resourceMapping": {"{{sourcePopulationsResource}}":"{{targetPopulationsResource}}"},
    "description": "Add population mapping"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"resourceMapping\": {\"{{sourcePopulationsResource}}\":\"{{targetPopulationsResource}}\"},\n    \"description\": \"Add population mapping\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}")
  .method("PATCH", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}",
  "method": "PATCH",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "resourceMapping": {
      "{{sourcePopulationsResource}}": "{{targetPopulationsResource}}"
    },
    "description": "Add population mapping"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PATCH',
  'url': '{{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "resourceMapping": {
      "{{sourcePopulationsResource}}": "{{targetPopulationsResource}}"
    },
    "description": "Add population mapping"
  })

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

url = "{{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}"

payload = json.dumps({
  "resourceMapping": {
    "{{sourcePopulationsResource}}": "{{targetPopulationsResource}}"
  },
  "description": "Add population mapping"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/promotions/{{promotionID}}');
$request->setMethod('PATCH');
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "resourceMapping": {"{{sourcePopulationsResource}}":"{{targetPopulationsResource}}"},\n    "description": "Add population mapping"\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}}/promotions/{{promotionID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "resourceMapping": {
    "{{sourcePopulationsResource}}": "{{targetPopulationsResource}}"
  },
  "description": "Add population mapping"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"resourceMapping\": {\"{{sourcePopulationsResource}}\":\"{{targetPopulationsResource}}\"},\n    \"description\": \"Add population mapping\"\n}"
let postData = parameters.data(using: .utf8)

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

request.httpMethod = "PATCH"
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": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/promotions/1d0ff9f4-0fae-4859-9dfa-0aa6cac9150e"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "targetEnvironment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "sourceSnapshot": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/versions/cc64ea07-1da0-4bf8-b487-5c178667d8c8"
        },
        "targetSnapshot": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/versions/77a10527-328a-432c-b04a-9530d3232164"
        }
    },
    "id": "1d0ff9f4-0fae-4859-9dfa-0aa6cac9150e",
    "createdAt": "2024-09-06T14:24:53.970Z",
    "updatedAt": "2024-09-11T14:44:28.760Z",
    "sourceEnvironmentId": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
    "rootResourceId": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
    "targetEnvironmentId": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
    "sourceSnapshotId": "cc64ea07-1da0-4bf8-b487-5c178667d8c8",
    "targetSnapshotId": "77a10527-328a-432c-b04a-9530d3232164",
    "status": "PREPARING",
    "selectedResources": [
        "0b7795ac-c589-4311-82bd-b1a9caff7a6a"
    ],
    "resourceMapping": {
        "2c3b1245-2c38-4174-97fa-069d88a543b1": "c7c92d16-e07b-4ddb-8d17-073fea3a219c"
    },
    "description": "Add population mapping"
}