Step 3: Get languages

GET {{apiPath}}/environments/{{envID}}/languages

The GET /environments/{{envID}}/languages returns a list of all languages associated with the specified environment, including the environment’s default language. An agreement can be enabled only if there is agreement revision content in the environment’s default language.

In the Postman collection for this workflow, the request includes a test script that finds your environment’s default language and uses it as the agreement language to create the revision content. By setting the agreement revision language to the environment’s default language, this action allows you to enable the agreement in Step 8.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/languages' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/languages")
{
  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}}/languages"
  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}}/languages 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}}/languages")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/languages",
  "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}}/languages',
  '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}}/languages"

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}}/languages');
$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}}/languages")

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}}/languages")!,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

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages"
        }
    },
    "_embedded": {
        "languages": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/2208dcef-58e8-499c-b8ae-fcbbd9129170"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/2208dcef-58e8-499c-b8ae-fcbbd9129170/status"
                    }
                },
                "id": "2208dcef-58e8-499c-b8ae-fcbbd9129170",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "zh",
                "name": "Chinese",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.793Z",
                "updatedAt": "2021-08-27T19:37:28.793Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f6a2e8e4-e23e-4406-ae2d-fc17b4104385"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f6a2e8e4-e23e-4406-ae2d-fc17b4104385/status"
                    }
                },
                "id": "f6a2e8e4-e23e-4406-ae2d-fc17b4104385",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "nl",
                "name": "Dutch",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.777Z",
                "updatedAt": "2021-08-27T19:37:28.777Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/c834317c-7a86-47eb-9528-3f13b4b96af9"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/c834317c-7a86-47eb-9528-3f13b4b96af9/status"
                    }
                },
                "id": "c834317c-7a86-47eb-9528-3f13b4b96af9",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "en",
                "name": "English",
                "enabled": true,
                "customerAdded": false,
                "createdAt": "2021-05-19T16:25:33.669Z",
                "updatedAt": "2021-05-19T16:25:33.669Z",
                "default": true
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/12dcc282-d2b3-4211-9ea5-d6e799defb40"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/12dcc282-d2b3-4211-9ea5-d6e799defb40/status"
                    }
                },
                "id": "12dcc282-d2b3-4211-9ea5-d6e799defb40",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "fr",
                "name": "French",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.758Z",
                "updatedAt": "2021-08-27T19:37:28.758Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/abe749dc-4596-4501-8d5b-415e72107820"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/abe749dc-4596-4501-8d5b-415e72107820/status"
                    }
                },
                "id": "abe749dc-4596-4501-8d5b-415e72107820",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "fr-CA",
                "name": "French (Canada)",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.762Z",
                "updatedAt": "2021-08-27T19:37:28.762Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/424ffe6e-317e-498d-b093-52bf64075648"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/424ffe6e-317e-498d-b093-52bf64075648/status"
                    }
                },
                "id": "424ffe6e-317e-498d-b093-52bf64075648",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "de",
                "name": "German",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.747Z",
                "updatedAt": "2021-08-27T19:37:28.747Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/cec6f848-925b-4fdd-ae27-6fba3c5c92a2"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/cec6f848-925b-4fdd-ae27-6fba3c5c92a2/status"
                    }
                },
                "id": "cec6f848-925b-4fdd-ae27-6fba3c5c92a2",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "it",
                "name": "Italian",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.765Z",
                "updatedAt": "2021-08-27T19:37:28.765Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f89ded1f-db30-43e0-b7ad-65dd2c0fdcd0"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f89ded1f-db30-43e0-b7ad-65dd2c0fdcd0/status"
                    }
                },
                "id": "f89ded1f-db30-43e0-b7ad-65dd2c0fdcd0",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "ja",
                "name": "Japanese",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.768Z",
                "updatedAt": "2021-08-27T19:37:28.768Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/44fc7d49-fb15-48f7-b7bc-0a52d5c4c789"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/44fc7d49-fb15-48f7-b7bc-0a52d5c4c789/status"
                    }
                },
                "id": "44fc7d49-fb15-48f7-b7bc-0a52d5c4c789",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "ko",
                "name": "Korean",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.774Z",
                "updatedAt": "2021-08-27T19:37:28.774Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f37264fb-d498-4c79-b74a-75df2f15c14b"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/f37264fb-d498-4c79-b74a-75df2f15c14b/status"
                    }
                },
                "id": "f37264fb-d498-4c79-b74a-75df2f15c14b",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "pt",
                "name": "Portuguese",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.780Z",
                "updatedAt": "2021-08-27T19:37:28.780Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/8ba67e2e-02f6-4f0f-9ac1-b5586d335359"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/8ba67e2e-02f6-4f0f-9ac1-b5586d335359/status"
                    }
                },
                "id": "8ba67e2e-02f6-4f0f-9ac1-b5586d335359",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "ru",
                "name": "Russian",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.784Z",
                "updatedAt": "2021-08-27T19:37:28.784Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/9073d2d8-e988-4132-bcf1-30a9cf834b0f"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/9073d2d8-e988-4132-bcf1-30a9cf834b0f/status"
                    }
                },
                "id": "9073d2d8-e988-4132-bcf1-30a9cf834b0f",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "es",
                "name": "Spanish",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.756Z",
                "updatedAt": "2021-08-27T19:37:28.756Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/0e0362ea-3a2c-4e6e-9c13-0efbac7c9436"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/0e0362ea-3a2c-4e6e-9c13-0efbac7c9436/status"
                    }
                },
                "id": "0e0362ea-3a2c-4e6e-9c13-0efbac7c9436",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "th",
                "name": "Thai",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.787Z",
                "updatedAt": "2021-08-27T19:37:28.787Z",
                "default": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/1e55d634-3985-4146-8dde-233f927ce0bf"
                    },
                    "status": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/1e55d634-3985-4146-8dde-233f927ce0bf/status"
                    }
                },
                "id": "1e55d634-3985-4146-8dde-233f927ce0bf",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "locale": "tr",
                "name": "Turkish",
                "enabled": false,
                "customerAdded": false,
                "hasToDoMessage": true,
                "createdAt": "2021-08-27T19:37:28.791Z",
                "updatedAt": "2021-08-27T19:37:28.791Z",
                "default": false
            }
        ]
    },
    "count": 14,
    "size": 14
}