PingOne Platform APIs

Create Language Localization Status

POST {{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status

The sample shows the POST {{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status operation to create a new language localization status resource associated with the language specified by its ID in the request URL.

Prerequisites

Prerequisites

Request Model
Property Type Required?

service

String

Required

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_Name2",
  "localizationComplete": true,
  "statusDetails": "Status details here"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

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

  payload := strings.NewReader(`{
  "service": "Service_Name2",
  "localizationComplete": true,
  "statusDetails": "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))
}
POST /environments/{{envID}}/languages/{{languageID}}/status HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

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

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "service": "Service_Name2",
    "localizationComplete": true,
    "statusDetails": "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"

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

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({
  "service": "Service_Name2",
  "localizationComplete": true,
  "statusDetails": "Status details here"
})

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

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/languages/{{languageID}}/status")!,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

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/languages/92734b7f-47f2-49d3-991e-94ffb83f6610/status/6e64acf5-d6d4-4979-8afc-d3f40c964d87"
        }
    },
    "id": "6e64acf5-d6d4-4979-8afc-d3f40c964d87",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "localeId": "92734b7f-47f2-49d3-991e-94ffb83f6610",
    "service": "Service_Name2",
    "localizationComplete": true,
    "statusDetails": "Status details here",
    "createdAt": "2020-12-10T16:30:08.849Z",
    "updatedAt": "2020-12-10T16:30:08.849Z"
}