Modify service state
curl --request POST \
--url https://api.example.com/services/{service}/state \
--header 'Content-Type: application/json' \
--data '
{
"new_state": {},
"object_key": "<string>",
"scope": "<string>",
"version": "<string>"
}
'import requests
url = "https://api.example.com/services/{service}/state"
payload = {
"new_state": {},
"object_key": "<string>",
"scope": "<string>",
"version": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({new_state: {}, object_key: '<string>', scope: '<string>', version: '<string>'})
};
fetch('https://api.example.com/services/{service}/state', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/services/{service}/state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'new_state' => [
],
'object_key' => '<string>',
'scope' => '<string>',
'version' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/services/{service}/state"
payload := strings.NewReader("{\n \"new_state\": {},\n \"object_key\": \"<string>\",\n \"scope\": \"<string>\",\n \"version\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/services/{service}/state")
.header("Content-Type", "application/json")
.body("{\n \"new_state\": {},\n \"object_key\": \"<string>\",\n \"scope\": \"<string>\",\n \"version\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/services/{service}/state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"new_state\": {},\n \"object_key\": \"<string>\",\n \"scope\": \"<string>\",\n \"version\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}service
Modify service state
Modifies the K/V state of a Virtual Object. For a detailed description of this API and how to use it, see the state documentation.
POST
/
services
/
{service}
/
state
Modify service state
curl --request POST \
--url https://api.example.com/services/{service}/state \
--header 'Content-Type: application/json' \
--data '
{
"new_state": {},
"object_key": "<string>",
"scope": "<string>",
"version": "<string>"
}
'import requests
url = "https://api.example.com/services/{service}/state"
payload = {
"new_state": {},
"object_key": "<string>",
"scope": "<string>",
"version": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({new_state: {}, object_key: '<string>', scope: '<string>', version: '<string>'})
};
fetch('https://api.example.com/services/{service}/state', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/services/{service}/state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'new_state' => [
],
'object_key' => '<string>',
'scope' => '<string>',
'version' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/services/{service}/state"
payload := strings.NewReader("{\n \"new_state\": {},\n \"object_key\": \"<string>\",\n \"scope\": \"<string>\",\n \"version\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/services/{service}/state")
.header("Content-Type", "application/json")
.body("{\n \"new_state\": {},\n \"object_key\": \"<string>\",\n \"scope\": \"<string>\",\n \"version\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/services/{service}/state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"new_state\": {},\n \"object_key\": \"<string>\",\n \"scope\": \"<string>\",\n \"version\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}{
"message": "<string>",
"restate_code": "<string>"
}Path Parameters
Fully qualified service name.
Body
application/json
New State
The new state to replace the previous state with
Show child attributes
Show child attributes
Service key
To what virtual object key to apply this change
Scope
Optional scope for the virtual object instance. When set, targets the scoped instance instead of the unscoped one. Since v1.7.0.
Version
If set, the latest version of the state is compared with this value and the operation will fail when the versions differ.
Response
State modification request accepted and will be applied asynchronously
Was this page helpful?
⌘I