PingOne Platform APIs

Step 10: Create a Workday writeback propagation rule mapping

 

POST {{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings

Use POST {{apiPath}}/environments/{{envID}}/propagation/rules/{{ruleID}}/mappings to add a Workday writeback propagation rule mapping associated with the specified propagation rule.

While required for Workday, writeback propagation rule mappings are specific to Workday and not used for other connection types.

Request Model
Property Type Required?

expression

String

Required/Optional

name

String

Required

sourceAttribute

String

Required/Optional

targetAttribute

String

Required

The propagation rule mapping between externalId and wid attributes depicted in this step is required between source and target for a Workday propagation connection. Rule mappings of additional attributes are necessary for a fully functional connection.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "sourceAttribute": "externalId",
    "targetAttribute": "wid"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "sourceAttribute": "externalId",
    "targetAttribute": "wid"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""sourceAttribute"": ""externalId""," + "\n" +
@"    ""targetAttribute"": ""wid""" + "\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}}/propagation/rules/{{wdWritebackRuleID}}/mappings"
  method := "POST"

  payload := strings.NewReader(`{
    "sourceAttribute": "externalId",
    "targetAttribute": "wid"
}`)

  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))
}
POST /environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "sourceAttribute": "externalId",
    "targetAttribute": "wid"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"sourceAttribute\": \"externalId\",\n    \"targetAttribute\": \"wid\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "sourceAttribute": "externalId",
    "targetAttribute": "wid"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "sourceAttribute": "externalId",
    "targetAttribute": "wid"
  })

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

url = "{{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings"

payload = json.dumps({
  "sourceAttribute": "externalId",
  "targetAttribute": "wid"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/propagation/rules/{{wdWritebackRuleID}}/mappings');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "sourceAttribute": "externalId",\n    "targetAttribute": "wid"\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}}/propagation/rules/{{wdWritebackRuleID}}/mappings")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "sourceAttribute": "externalId",
  "targetAttribute": "wid"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"sourceAttribute\": \"externalId\",\n    \"targetAttribute\": \"wid\"\n}"
let postData = parameters.data(using: .utf8)

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

request.httpMethod = "POST"
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

201 Created

{
    "id": "fd40119a-73bb-4e85-9f47-4c9d3990a86b",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "createdAt": "2022-10-11T14:39:49.978Z",
    "updatedAt": "2022-10-11T14:39:49.978Z",
    "rule": {
        "id": "12e82a11-26d2-4ca6-b221-0b55fd1200ac"
    },
    "sourceAttribute": "externalId",
    "targetAttribute": "wid",
    "_links": {
        "get": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/mappings/fd40119a-73bb-4e85-9f47-4c9d3990a86b"
        },
        "create": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/12e82a11-26d2-4ca6-b221-0b55fd1200ac/mappings"
        },
        "update": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/mappings/fd40119a-73bb-4e85-9f47-4c9d3990a86b"
        },
        "delete": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/mappings/fd40119a-73bb-4e85-9f47-4c9d3990a86b"
        }
    }
}