PingOne Platform APIs

Update Language Localization Status

PUT {{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}}

The PUT {{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}} operation updates the localization status for the language resource specified by its ID in the request URL.

Prerequisites

Request Model
Property Type Required?

localizationComplete

Boolean

Required

service

String

Required

statusDetails

String

Optional

Refer to the Language localization status data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
  "service": "Service_Name1",
  "localizationComplete": true,
  "statusDetails": "Status Details - add updated status details here"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "service": "Service_Name1",
  "localizationComplete": true,
  "statusDetails": "Status Details - add updated status details here"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}}")
{
  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" +
@"  ""service"": ""Service_Name1""," + "\n" +
@"  ""localizationComplete"": true," + "\n" +
@"  ""statusDetails"": ""Status Details - add updated status details here""" + "\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}}/languages/{{languageID}}/status/{{l10nStatusID}}"
  method := "PUT"

  payload := strings.NewReader(`{
  "service": "Service_Name1",
  "localizationComplete": true,
  "statusDetails": "Status Details - add updated status details here"
}`)

  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}}/languages/{{languageID}}/status/{{l10nStatusID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
  "service": "Service_Name1",
  "localizationComplete": true,
  "statusDetails": "Status Details - add updated status details here"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"service\": \"Service_Name1\",\n  \"localizationComplete\": true,\n  \"statusDetails\": \"Status Details - add updated status details here\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}}")
  .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}}/languages/{{languageID}}/status/{{l10nStatusID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "service": "Service_Name1",
    "localizationComplete": true,
    "statusDetails": "Status Details - add updated status details here"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "service": "Service_Name1",
    "localizationComplete": true,
    "statusDetails": "Status Details - add updated status details here"
  })

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

url = "{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}}"

payload = json.dumps({
  "service": "Service_Name1",
  "localizationComplete": True,
  "statusDetails": "Status Details - add updated status details here"
})
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}}/languages/{{languageID}}/status/{{l10nStatusID}}');
$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  "service": "Service_Name1",\n  "localizationComplete": true,\n  "statusDetails": "Status Details - add updated status details here"\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}}/languages/{{languageID}}/status/{{l10nStatusID}}")

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({
  "service": "Service_Name1",
  "localizationComplete": true,
  "statusDetails": "Status Details - add updated status details here"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"service\": \"Service_Name1\",\n  \"localizationComplete\": true,\n  \"statusDetails\": \"Status Details - add updated status details here\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status/{{l10nStatusID}}")!,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": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/92734b7f-47f2-49d3-991e-94ffb83f6610/status/d647054e-507d-4020-80ab-a1bf2086052e"
        }
    },
    "id": "d647054e-507d-4020-80ab-a1bf2086052e",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "localeId": "92734b7f-47f2-49d3-991e-94ffb83f6610",
    "service": "Service_Name1",
    "localizationComplete": true,
    "statusDetails": "Status Details - add updated status details here",
    "createdAt": "2020-11-20T21:01:01.610Z",
    "updatedAt": "2020-11-20T23:13:21.608Z"
}