PingOne Platform APIs

Read All Revisions

 

GET {{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions

The GET {{apiPath}}/environments/{{envID}}/agreement/{{agreementID}}/languages/{{languageID}}/revisions endpoint operation returns all revision resources associated with the agreement and language resource IDs specified in the request URL.

The response does not include the text property. To access this value, use the _links.text URL.

Response data paging is not available at this time.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  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))
}
GET /environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
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 "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/agreements/{{agreementID}}/languages/{{languageID}}/revisions")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

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

{
    "count": 3,
    "size": 3,
    "_embedded": {
        "revisions": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea/revisions/3ac6cf68-0bbf-4b50-a5a6-8e697d8e4d6a"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "agreement": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4"
                    },
                    "language": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea"
                    },
                    "text": {
                        "href": "https://agreement-mgmt.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea/revisions/3ac6cf68-0bbf-4b50-a5a6-8e697d8e4d6a.json"
                    }
                },
                "id": "3ac6cf68-0bbf-4b50-a5a6-8e697d8e4d6a",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "agreement": {
                    "id": "d462d436-cf80-421c-8c05-881e9958c4b4"
                },
                "language": {
                    "id": "7e156496-4e67-4adc-a139-ebbbbe2c1aea"
                },
                "effectiveAt": "2022-05-07T22:45:44.497Z",
                "contentType": "text/plain",
                "requireReconsent": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea/revisions/80c9eca2-063e-4a19-b834-7e9f733bf8b5"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "agreement": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4"
                    },
                    "language": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea"
                    },
                    "text": {
                        "href": "https://agreement-mgmt.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea/revisions/80c9eca2-063e-4a19-b834-7e9f733bf8b5.json"
                    }
                },
                "id": "80c9eca2-063e-4a19-b834-7e9f733bf8b5",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "agreement": {
                    "id": "d462d436-cf80-421c-8c05-881e9958c4b4"
                },
                "language": {
                    "id": "7e156496-4e67-4adc-a139-ebbbbe2c1aea"
                },
                "effectiveAt": "2099-08-01T22:45:44.497Z",
                "contentType": "text/plain",
                "requireReconsent": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea/revisions/aab73db4-9432-4149-9d24-daa8e6e1289b"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "agreement": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4"
                    },
                    "language": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea"
                    },
                    "text": {
                        "href": "https://agreement-mgmt.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/d462d436-cf80-421c-8c05-881e9958c4b4/languages/7e156496-4e67-4adc-a139-ebbbbe2c1aea/revisions/aab73db4-9432-4149-9d24-daa8e6e1289b.json"
                    }
                },
                "id": "aab73db4-9432-4149-9d24-daa8e6e1289b",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "agreement": {
                    "id": "d462d436-cf80-421c-8c05-881e9958c4b4"
                },
                "language": {
                    "id": "7e156496-4e67-4adc-a139-ebbbbe2c1aea"
                },
                "effectiveAt": "2098-08-01T22:45:44.497Z",
                "contentType": "text/plain",
                "requireReconsent": false
            }
        ]
    }
}