Master Data API - v2
Master Data API - v2v1.0
ATTENTION: This version isn't compliant with data entities of old version (e.g. CL and AD). It's possible to use this configuration only to new data entities. Welcome! VTEX Master Data is an easy-to-use, secure, fast, scalable and extensible repository. On it you can create your own Entities, store data and consult directly from the storefront or use it to store info for some external integration. There are internal VTEX modules that use VTEX Master Data as data repository. We have the VTEX Customer Service, VTEX Profile System and VTEX InStore, for example. It is also used by other internal…
- Endpoints
- 26 (9 GET, 5 DELETE, 4 POST, 4 PATCH)
- Base URL
https://vtex.local- Authentication
- API key
- Spec format
- OpenAPI 3.0.0
- API version
- 1.0
- Provider
- vtex.local
- Last updated
Use this API in Bruno:
- Download the Bruno collection above and unzip it.
- In Bruno, choose Open Collection and select the unzipped folder.
- Set the
baseUrlvariable (for examplehttps://vtex.local) and your API key credentials, then send requests.
POST
Create new customer address
{{baseUrl}}/api/dataentities/Address/documents
HEADERS
Content-Type
Accept
BODY json
{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/Address/documents");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/api/dataentities/Address/documents" {:headers {:accept ""}
:content-type :json
:form-params {:addressName ""
:addressType ""
:city ""
:complement ""
:country ""
:neighborhood ""
:number ""
:postalCode ""
:receiverName ""
:reference ""
:state ""
:street ""
:userId ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/Address/documents"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
reqBody = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/Address/documents"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/Address/documents");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddParameter("", "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/Address/documents"
payload := strings.NewReader("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/api/dataentities/Address/documents HTTP/1.1
Content-Type:
Accept:
Host: example.com
Content-Length: 241
{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/api/dataentities/Address/documents")
.setHeader("content-type", "")
.setHeader("accept", "")
.setBody("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/Address/documents"))
.header("content-type", "")
.header("accept", "")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/Address/documents")
.post(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/api/dataentities/Address/documents")
.header("content-type", "")
.header("accept", "")
.body("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
.asString();
const data = JSON.stringify({
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/api/dataentities/Address/documents');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/Address/documents',
headers: {'content-type': '', accept: ''},
data: {
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/Address/documents';
const options = {
method: 'POST',
headers: {'content-type': '', accept: ''},
body: '{"addressName":"","addressType":"","city":"","complement":"","country":"","neighborhood":"","number":"","postalCode":"","receiverName":"","reference":"","state":"","street":"","userId":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/Address/documents',
method: 'POST',
headers: {
'content-type': '',
accept: ''
},
processData: false,
data: '{\n "addressName": "",\n "addressType": "",\n "city": "",\n "complement": "",\n "country": "",\n "neighborhood": "",\n "number": "",\n "postalCode": "",\n "receiverName": "",\n "reference": "",\n "state": "",\n "street": "",\n "userId": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/Address/documents")
.post(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/Address/documents',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/Address/documents',
headers: {'content-type': '', accept: ''},
body: {
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/api/dataentities/Address/documents');
req.headers({
'content-type': '',
accept: ''
});
req.type('json');
req.send({
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/Address/documents',
headers: {'content-type': '', accept: ''},
data: {
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/Address/documents';
const options = {
method: 'POST',
headers: {'content-type': '', accept: ''},
body: '{"addressName":"","addressType":"","city":"","complement":"","country":"","neighborhood":"","number":"","postalCode":"","receiverName":"","reference":"","state":"","street":"","userId":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSDictionary *parameters = @{ @"addressName": @"",
@"addressType": @"",
@"city": @"",
@"complement": @"",
@"country": @"",
@"neighborhood": @"",
@"number": @"",
@"postalCode": @"",
@"receiverName": @"",
@"reference": @"",
@"state": @"",
@"street": @"",
@"userId": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/Address/documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/Address/documents" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
let body = Cohttp_lwt_body.of_string "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/Address/documents",
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([
'addressName' => '',
'addressType' => '',
'city' => '',
'complement' => '',
'country' => '',
'neighborhood' => '',
'number' => '',
'postalCode' => '',
'receiverName' => '',
'reference' => '',
'state' => '',
'street' => '',
'userId' => ''
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/api/dataentities/Address/documents', [
'body' => '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}',
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/Address/documents');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'addressName' => '',
'addressType' => '',
'city' => '',
'complement' => '',
'country' => '',
'neighborhood' => '',
'number' => '',
'postalCode' => '',
'receiverName' => '',
'reference' => '',
'state' => '',
'street' => '',
'userId' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'addressName' => '',
'addressType' => '',
'city' => '',
'complement' => '',
'country' => '',
'neighborhood' => '',
'number' => '',
'postalCode' => '',
'receiverName' => '',
'reference' => '',
'state' => '',
'street' => '',
'userId' => ''
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/Address/documents');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/Address/documents' -Method POST -Headers $headers -ContentType '' -Body '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}'
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/Address/documents' -Method POST -Headers $headers -ContentType '' -Body '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
headers = {
'content-type': "",
'accept': ""
}
conn.request("POST", "/baseUrl/api/dataentities/Address/documents", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/Address/documents"
payload = {
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}
headers = {
"content-type": "",
"accept": ""
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/Address/documents"
payload <- "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/Address/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = ''
request["accept"] = ''
request.body = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/api/dataentities/Address/documents') do |req|
req.headers['accept'] = ''
req.body = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/Address/documents";
let payload = json!({
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/api/dataentities/Address/documents \
--header 'accept: ' \
--header 'content-type: ' \
--data '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}'
echo '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}' | \
http POST {{baseUrl}}/api/dataentities/Address/documents \
accept:'' \
content-type:''
wget --quiet \
--method POST \
--header 'content-type: ' \
--header 'accept: ' \
--body-data '{\n "addressName": "",\n "addressType": "",\n "city": "",\n "complement": "",\n "country": "",\n "neighborhood": "",\n "number": "",\n "postalCode": "",\n "receiverName": "",\n "reference": "",\n "state": "",\n "street": "",\n "userId": ""\n}' \
--output-document \
- {{baseUrl}}/api/dataentities/Address/documents
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let parameters = [
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/Address/documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Address/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "AD-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
DELETE
Delete customer address
{{baseUrl}}/api/dataentities/Address/documents/:id
HEADERS
Content-Type
Accept
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/Address/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/api/dataentities/Address/documents/:id" {:headers {:content-type ""
:accept ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/Address/documents/:id"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/Address/documents/:id"),
Headers =
{
{ "accept", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/Address/documents/:id");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/Address/documents/:id"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/api/dataentities/Address/documents/:id HTTP/1.1
Content-Type:
Accept:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/api/dataentities/Address/documents/:id")
.setHeader("content-type", "")
.setHeader("accept", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/Address/documents/:id"))
.header("content-type", "")
.header("accept", "")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/Address/documents/:id")
.delete(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/api/dataentities/Address/documents/:id")
.header("content-type", "")
.header("accept", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/api/dataentities/Address/documents/:id');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/Address/documents/:id';
const options = {method: 'DELETE', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
method: 'DELETE',
headers: {
'content-type': '',
accept: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/Address/documents/:id")
.delete(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/Address/documents/:id',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
headers: {'content-type': '', accept: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/api/dataentities/Address/documents/:id');
req.headers({
'content-type': '',
accept: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/Address/documents/:id';
const options = {method: 'DELETE', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/Address/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/Address/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/Address/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/api/dataentities/Address/documents/:id', [
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/Address/documents/:id');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/Address/documents/:id');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/Address/documents/:id' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/Address/documents/:id' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': ""
}
conn.request("DELETE", "/baseUrl/api/dataentities/Address/documents/:id", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/Address/documents/:id"
headers = {
"content-type": "",
"accept": ""
}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/Address/documents/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/Address/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = ''
request["accept"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/api/dataentities/Address/documents/:id') do |req|
req.headers['accept'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/Address/documents/:id";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/api/dataentities/Address/documents/:id \
--header 'accept: ' \
--header 'content-type: '
http DELETE {{baseUrl}}/api/dataentities/Address/documents/:id \
accept:'' \
content-type:''
wget --quiet \
--method DELETE \
--header 'content-type: ' \
--header 'accept: ' \
--output-document \
- {{baseUrl}}/api/dataentities/Address/documents/:id
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/Address/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Address/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "AD-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
PATCH
Update customer address
{{baseUrl}}/api/dataentities/Address/documents/:id
HEADERS
Content-Type
Accept
QUERY PARAMS
id
BODY json
{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/Address/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/api/dataentities/Address/documents/:id" {:headers {:accept ""}
:content-type :json
:form-params {:addressName ""
:addressType ""
:city ""
:complement ""
:country ""
:neighborhood ""
:number ""
:postalCode ""
:receiverName ""
:reference ""
:state ""
:street ""
:userId ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/Address/documents/:id"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
reqBody = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/Address/documents/:id"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/Address/documents/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddParameter("", "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/Address/documents/:id"
payload := strings.NewReader("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/api/dataentities/Address/documents/:id HTTP/1.1
Content-Type:
Accept:
Host: example.com
Content-Length: 241
{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/api/dataentities/Address/documents/:id")
.setHeader("content-type", "")
.setHeader("accept", "")
.setBody("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/Address/documents/:id"))
.header("content-type", "")
.header("accept", "")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/Address/documents/:id")
.patch(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/api/dataentities/Address/documents/:id")
.header("content-type", "")
.header("accept", "")
.body("{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
.asString();
const data = JSON.stringify({
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/api/dataentities/Address/documents/:id');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
headers: {'content-type': '', accept: ''},
data: {
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/Address/documents/:id';
const options = {
method: 'PATCH',
headers: {'content-type': '', accept: ''},
body: '{"addressName":"","addressType":"","city":"","complement":"","country":"","neighborhood":"","number":"","postalCode":"","receiverName":"","reference":"","state":"","street":"","userId":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
method: 'PATCH',
headers: {
'content-type': '',
accept: ''
},
processData: false,
data: '{\n "addressName": "",\n "addressType": "",\n "city": "",\n "complement": "",\n "country": "",\n "neighborhood": "",\n "number": "",\n "postalCode": "",\n "receiverName": "",\n "reference": "",\n "state": "",\n "street": "",\n "userId": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/Address/documents/:id")
.patch(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/Address/documents/:id',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
headers: {'content-type': '', accept: ''},
body: {
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/api/dataentities/Address/documents/:id');
req.headers({
'content-type': '',
accept: ''
});
req.type('json');
req.send({
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/Address/documents/:id',
headers: {'content-type': '', accept: ''},
data: {
addressName: '',
addressType: '',
city: '',
complement: '',
country: '',
neighborhood: '',
number: '',
postalCode: '',
receiverName: '',
reference: '',
state: '',
street: '',
userId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/Address/documents/:id';
const options = {
method: 'PATCH',
headers: {'content-type': '', accept: ''},
body: '{"addressName":"","addressType":"","city":"","complement":"","country":"","neighborhood":"","number":"","postalCode":"","receiverName":"","reference":"","state":"","street":"","userId":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSDictionary *parameters = @{ @"addressName": @"",
@"addressType": @"",
@"city": @"",
@"complement": @"",
@"country": @"",
@"neighborhood": @"",
@"number": @"",
@"postalCode": @"",
@"receiverName": @"",
@"reference": @"",
@"state": @"",
@"street": @"",
@"userId": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/Address/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/Address/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
let body = Cohttp_lwt_body.of_string "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/Address/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'addressName' => '',
'addressType' => '',
'city' => '',
'complement' => '',
'country' => '',
'neighborhood' => '',
'number' => '',
'postalCode' => '',
'receiverName' => '',
'reference' => '',
'state' => '',
'street' => '',
'userId' => ''
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/api/dataentities/Address/documents/:id', [
'body' => '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}',
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/Address/documents/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'addressName' => '',
'addressType' => '',
'city' => '',
'complement' => '',
'country' => '',
'neighborhood' => '',
'number' => '',
'postalCode' => '',
'receiverName' => '',
'reference' => '',
'state' => '',
'street' => '',
'userId' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'addressName' => '',
'addressType' => '',
'city' => '',
'complement' => '',
'country' => '',
'neighborhood' => '',
'number' => '',
'postalCode' => '',
'receiverName' => '',
'reference' => '',
'state' => '',
'street' => '',
'userId' => ''
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/Address/documents/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/Address/documents/:id' -Method PATCH -Headers $headers -ContentType '' -Body '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}'
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/Address/documents/:id' -Method PATCH -Headers $headers -ContentType '' -Body '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
headers = {
'content-type': "",
'accept': ""
}
conn.request("PATCH", "/baseUrl/api/dataentities/Address/documents/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/Address/documents/:id"
payload = {
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}
headers = {
"content-type": "",
"accept": ""
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/Address/documents/:id"
payload <- "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/Address/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = ''
request["accept"] = ''
request.body = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/api/dataentities/Address/documents/:id') do |req|
req.headers['accept'] = ''
req.body = "{\n \"addressName\": \"\",\n \"addressType\": \"\",\n \"city\": \"\",\n \"complement\": \"\",\n \"country\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"postalCode\": \"\",\n \"receiverName\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"userId\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/Address/documents/:id";
let payload = json!({
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/api/dataentities/Address/documents/:id \
--header 'accept: ' \
--header 'content-type: ' \
--data '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}'
echo '{
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
}' | \
http PATCH {{baseUrl}}/api/dataentities/Address/documents/:id \
accept:'' \
content-type:''
wget --quiet \
--method PATCH \
--header 'content-type: ' \
--header 'accept: ' \
--body-data '{\n "addressName": "",\n "addressType": "",\n "city": "",\n "complement": "",\n "country": "",\n "neighborhood": "",\n "number": "",\n "postalCode": "",\n "receiverName": "",\n "reference": "",\n "state": "",\n "street": "",\n "userId": ""\n}' \
--output-document \
- {{baseUrl}}/api/dataentities/Address/documents/:id
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let parameters = [
"addressName": "",
"addressType": "",
"city": "",
"complement": "",
"country": "",
"neighborhood": "",
"number": "",
"postalCode": "",
"receiverName": "",
"reference": "",
"state": "",
"street": "",
"userId": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/Address/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Address/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "AD-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
POST
Validate document by clusters
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters
HEADERS
Accept
QUERY PARAMS
dataEntityName
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "accept: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters" {:headers {:accept ""}
:content-type :json
:form-params [{:name "male"
:rule "gender=male"} {:name "complex"
:rule "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"} {:name "complex2"
:rule "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"} {:name "createdIn"
:rule "createdIn between 2015-10-28 AND 2015-10-30"}]})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters"
headers = HTTP::Headers{
"accept" => ""
"content-type" => "application/json"
}
reqBody = "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters");
var request = new RestRequest("", Method.Post);
request.AddHeader("accept", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters"
payload := strings.NewReader("[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("accept", "")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/api/dataentities/:dataEntityName/documents/:id/clusters HTTP/1.1
Accept:
Content-Type: application/json
Host: example.com
Content-Length: 435
[
{
"name": "male",
"rule": "gender=male"
},
{
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
},
{
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
},
{
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
}
]
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters")
.setHeader("accept", "")
.setHeader("content-type", "application/json")
.setBody("[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters"))
.header("accept", "")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters")
.post(body)
.addHeader("accept", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters")
.header("accept", "")
.header("content-type", "application/json")
.body("[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]")
.asString();
const data = JSON.stringify([
{
name: 'male',
rule: 'gender=male'
},
{
name: 'complex',
rule: '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
},
{
name: 'complex2',
rule: '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
},
{
name: 'createdIn',
rule: 'createdIn between 2015-10-28 AND 2015-10-30'
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters');
xhr.setRequestHeader('accept', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters',
headers: {accept: '', 'content-type': 'application/json'},
data: [
{name: 'male', rule: 'gender=male'},
{
name: 'complex',
rule: '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
},
{
name: 'complex2',
rule: '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
},
{name: 'createdIn', rule: 'createdIn between 2015-10-28 AND 2015-10-30'}
]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters';
const options = {
method: 'POST',
headers: {accept: '', 'content-type': 'application/json'},
body: '[{"name":"male","rule":"gender=male"},{"name":"complex","rule":"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"},{"name":"complex2","rule":"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"},{"name":"createdIn","rule":"createdIn between 2015-10-28 AND 2015-10-30"}]'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters',
method: 'POST',
headers: {
accept: '',
'content-type': 'application/json'
},
processData: false,
data: '[\n {\n "name": "male", \n "rule": "gender=male"\n },\n {\n "name": "complex",\n "rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"\n }, \n {\n "name": "complex2",\n "rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"\n },\n {\n "name": "createdIn",\n "rule": "createdIn between 2015-10-28 AND 2015-10-30"\n }\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters")
.post(body)
.addHeader("accept", "")
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id/clusters',
headers: {
accept: '',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([
{name: 'male', rule: 'gender=male'},
{
name: 'complex',
rule: '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
},
{
name: 'complex2',
rule: '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
},
{name: 'createdIn', rule: 'createdIn between 2015-10-28 AND 2015-10-30'}
]));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters',
headers: {accept: '', 'content-type': 'application/json'},
body: [
{name: 'male', rule: 'gender=male'},
{
name: 'complex',
rule: '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
},
{
name: 'complex2',
rule: '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
},
{name: 'createdIn', rule: 'createdIn between 2015-10-28 AND 2015-10-30'}
],
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters');
req.headers({
accept: '',
'content-type': 'application/json'
});
req.type('json');
req.send([
{
name: 'male',
rule: 'gender=male'
},
{
name: 'complex',
rule: '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
},
{
name: 'complex2',
rule: '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
},
{
name: 'createdIn',
rule: 'createdIn between 2015-10-28 AND 2015-10-30'
}
]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters',
headers: {accept: '', 'content-type': 'application/json'},
data: [
{name: 'male', rule: 'gender=male'},
{
name: 'complex',
rule: '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
},
{
name: 'complex2',
rule: '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
},
{name: 'createdIn', rule: 'createdIn between 2015-10-28 AND 2015-10-30'}
]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters';
const options = {
method: 'POST',
headers: {accept: '', 'content-type': 'application/json'},
body: '[{"name":"male","rule":"gender=male"},{"name":"complex","rule":"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"},{"name":"complex2","rule":"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"},{"name":"createdIn","rule":"createdIn between 2015-10-28 AND 2015-10-30"}]'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"accept": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @[ @{ @"name": @"male", @"rule": @"gender=male" },
@{ @"name": @"complex", @"rule": @"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)" },
@{ @"name": @"complex2", @"rule": @"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)" },
@{ @"name": @"createdIn", @"rule": @"createdIn between 2015-10-28 AND 2015-10-30" } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters" in
let headers = Header.add_list (Header.init ()) [
("accept", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters",
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([
[
'name' => 'male',
'rule' => 'gender=male'
],
[
'name' => 'complex',
'rule' => '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
],
[
'name' => 'complex2',
'rule' => '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
],
[
'name' => 'createdIn',
'rule' => 'createdIn between 2015-10-28 AND 2015-10-30'
]
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters', [
'body' => '[
{
"name": "male",
"rule": "gender=male"
},
{
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
},
{
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
},
{
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
}
]',
'headers' => [
'accept' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'accept' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
'name' => 'male',
'rule' => 'gender=male'
],
[
'name' => 'complex',
'rule' => '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
],
[
'name' => 'complex2',
'rule' => '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
],
[
'name' => 'createdIn',
'rule' => 'createdIn between 2015-10-28 AND 2015-10-30'
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
[
'name' => 'male',
'rule' => 'gender=male'
],
[
'name' => 'complex',
'rule' => '((gender=male AND percent=0.35) AND any is null) AND (name=*go*)'
],
[
'name' => 'complex2',
'rule' => '((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)'
],
[
'name' => 'createdIn',
'rule' => 'createdIn between 2015-10-28 AND 2015-10-30'
]
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'accept' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("accept", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"name": "male",
"rule": "gender=male"
},
{
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
},
{
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
},
{
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
}
]'
$headers=@{}
$headers.Add("accept", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"name": "male",
"rule": "gender=male"
},
{
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
},
{
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
},
{
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
}
]'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]"
headers = {
'accept': "",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/api/dataentities/:dataEntityName/documents/:id/clusters", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters"
payload = [
{
"name": "male",
"rule": "gender=male"
},
{
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
},
{
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
},
{
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
}
]
headers = {
"accept": "",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters"
payload <- "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = ''
request["content-type"] = 'application/json'
request.body = "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/api/dataentities/:dataEntityName/documents/:id/clusters') do |req|
req.headers['accept'] = ''
req.body = "[\n {\n \"name\": \"male\", \n \"rule\": \"gender=male\"\n },\n {\n \"name\": \"complex\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is null) AND (name=*go*)\"\n }, \n {\n \"name\": \"complex2\",\n \"rule\": \"((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)\"\n },\n {\n \"name\": \"createdIn\",\n \"rule\": \"createdIn between 2015-10-28 AND 2015-10-30\"\n }\n]"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters";
let payload = (
json!({
"name": "male",
"rule": "gender=male"
}),
json!({
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
}),
json!({
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
}),
json!({
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
})
);
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("accept", "".parse().unwrap());
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters \
--header 'accept: ' \
--header 'content-type: application/json' \
--data '[
{
"name": "male",
"rule": "gender=male"
},
{
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
},
{
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
},
{
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
}
]'
echo '[
{
"name": "male",
"rule": "gender=male"
},
{
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
},
{
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
},
{
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
}
]' | \
http POST {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters \
accept:'' \
content-type:application/json
wget --quiet \
--method POST \
--header 'accept: ' \
--header 'content-type: application/json' \
--body-data '[\n {\n "name": "male", \n "rule": "gender=male"\n },\n {\n "name": "complex",\n "rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"\n }, \n {\n "name": "complex2",\n "rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"\n },\n {\n "name": "createdIn",\n "rule": "createdIn between 2015-10-28 AND 2015-10-30"\n }\n]' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters
import Foundation
let headers = [
"accept": "",
"content-type": "application/json"
]
let parameters = [
[
"name": "male",
"rule": "gender=male"
],
[
"name": "complex",
"rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
],
[
"name": "complex2",
"rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
],
[
"name": "createdIn",
"rule": "createdIn between 2015-10-28 AND 2015-10-30"
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/clusters")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create new customer profile
{{baseUrl}}/api/dataentities/Client/documents
HEADERS
Content-Type
Accept
BODY json
{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/Client/documents");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/api/dataentities/Client/documents" {:headers {:accept ""}
:content-type :json
:form-params {:document ""
:documentType ""
:email ""
:firstName ""
:isCorporate false
:isNewsletterOptIn false
:lastName ""
:localeDefault ""
:phone ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/Client/documents"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
reqBody = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/Client/documents"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/Client/documents");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddParameter("", "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/Client/documents"
payload := strings.NewReader("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/api/dataentities/Client/documents HTTP/1.1
Content-Type:
Accept:
Host: example.com
Content-Length: 186
{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/api/dataentities/Client/documents")
.setHeader("content-type", "")
.setHeader("accept", "")
.setBody("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/Client/documents"))
.header("content-type", "")
.header("accept", "")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/Client/documents")
.post(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/api/dataentities/Client/documents")
.header("content-type", "")
.header("accept", "")
.body("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
.asString();
const data = JSON.stringify({
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/api/dataentities/Client/documents');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/Client/documents',
headers: {'content-type': '', accept: ''},
data: {
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/Client/documents';
const options = {
method: 'POST',
headers: {'content-type': '', accept: ''},
body: '{"document":"","documentType":"","email":"","firstName":"","isCorporate":false,"isNewsletterOptIn":false,"lastName":"","localeDefault":"","phone":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/Client/documents',
method: 'POST',
headers: {
'content-type': '',
accept: ''
},
processData: false,
data: '{\n "document": "",\n "documentType": "",\n "email": "",\n "firstName": "",\n "isCorporate": false,\n "isNewsletterOptIn": false,\n "lastName": "",\n "localeDefault": "",\n "phone": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/Client/documents")
.post(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/Client/documents',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/Client/documents',
headers: {'content-type': '', accept: ''},
body: {
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/api/dataentities/Client/documents');
req.headers({
'content-type': '',
accept: ''
});
req.type('json');
req.send({
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/Client/documents',
headers: {'content-type': '', accept: ''},
data: {
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/Client/documents';
const options = {
method: 'POST',
headers: {'content-type': '', accept: ''},
body: '{"document":"","documentType":"","email":"","firstName":"","isCorporate":false,"isNewsletterOptIn":false,"lastName":"","localeDefault":"","phone":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSDictionary *parameters = @{ @"document": @"",
@"documentType": @"",
@"email": @"",
@"firstName": @"",
@"isCorporate": @NO,
@"isNewsletterOptIn": @NO,
@"lastName": @"",
@"localeDefault": @"",
@"phone": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/Client/documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/Client/documents" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
let body = Cohttp_lwt_body.of_string "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/Client/documents",
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([
'document' => '',
'documentType' => '',
'email' => '',
'firstName' => '',
'isCorporate' => null,
'isNewsletterOptIn' => null,
'lastName' => '',
'localeDefault' => '',
'phone' => ''
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/api/dataentities/Client/documents', [
'body' => '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}',
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/Client/documents');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'document' => '',
'documentType' => '',
'email' => '',
'firstName' => '',
'isCorporate' => null,
'isNewsletterOptIn' => null,
'lastName' => '',
'localeDefault' => '',
'phone' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'document' => '',
'documentType' => '',
'email' => '',
'firstName' => '',
'isCorporate' => null,
'isNewsletterOptIn' => null,
'lastName' => '',
'localeDefault' => '',
'phone' => ''
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/Client/documents');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/Client/documents' -Method POST -Headers $headers -ContentType '' -Body '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}'
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/Client/documents' -Method POST -Headers $headers -ContentType '' -Body '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
headers = {
'content-type': "",
'accept': ""
}
conn.request("POST", "/baseUrl/api/dataentities/Client/documents", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/Client/documents"
payload = {
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": False,
"isNewsletterOptIn": False,
"lastName": "",
"localeDefault": "",
"phone": ""
}
headers = {
"content-type": "",
"accept": ""
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/Client/documents"
payload <- "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/Client/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = ''
request["accept"] = ''
request.body = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/api/dataentities/Client/documents') do |req|
req.headers['accept'] = ''
req.body = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/Client/documents";
let payload = json!({
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/api/dataentities/Client/documents \
--header 'accept: ' \
--header 'content-type: ' \
--data '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}'
echo '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}' | \
http POST {{baseUrl}}/api/dataentities/Client/documents \
accept:'' \
content-type:''
wget --quiet \
--method POST \
--header 'content-type: ' \
--header 'accept: ' \
--body-data '{\n "document": "",\n "documentType": "",\n "email": "",\n "firstName": "",\n "isCorporate": false,\n "isNewsletterOptIn": false,\n "lastName": "",\n "localeDefault": "",\n "phone": ""\n}' \
--output-document \
- {{baseUrl}}/api/dataentities/Client/documents
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let parameters = [
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/Client/documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
DELETE
Delete customer profile
{{baseUrl}}/api/dataentities/Client/documents/:id
HEADERS
Content-Type
Accept
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/Client/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/api/dataentities/Client/documents/:id" {:headers {:content-type ""
:accept ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/Client/documents/:id"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/Client/documents/:id"),
Headers =
{
{ "accept", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/Client/documents/:id");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/Client/documents/:id"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/api/dataentities/Client/documents/:id HTTP/1.1
Content-Type:
Accept:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/api/dataentities/Client/documents/:id")
.setHeader("content-type", "")
.setHeader("accept", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/Client/documents/:id"))
.header("content-type", "")
.header("accept", "")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/Client/documents/:id")
.delete(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/api/dataentities/Client/documents/:id")
.header("content-type", "")
.header("accept", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/api/dataentities/Client/documents/:id');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/Client/documents/:id';
const options = {method: 'DELETE', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
method: 'DELETE',
headers: {
'content-type': '',
accept: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/Client/documents/:id")
.delete(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/Client/documents/:id',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
headers: {'content-type': '', accept: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/api/dataentities/Client/documents/:id');
req.headers({
'content-type': '',
accept: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/Client/documents/:id';
const options = {method: 'DELETE', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/Client/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/Client/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/Client/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/api/dataentities/Client/documents/:id', [
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/Client/documents/:id');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/Client/documents/:id');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/Client/documents/:id' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/Client/documents/:id' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': ""
}
conn.request("DELETE", "/baseUrl/api/dataentities/Client/documents/:id", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/Client/documents/:id"
headers = {
"content-type": "",
"accept": ""
}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/Client/documents/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/Client/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = ''
request["accept"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/api/dataentities/Client/documents/:id') do |req|
req.headers['accept'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/Client/documents/:id";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/api/dataentities/Client/documents/:id \
--header 'accept: ' \
--header 'content-type: '
http DELETE {{baseUrl}}/api/dataentities/Client/documents/:id \
accept:'' \
content-type:''
wget --quiet \
--method DELETE \
--header 'content-type: ' \
--header 'accept: ' \
--output-document \
- {{baseUrl}}/api/dataentities/Client/documents/:id
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/Client/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
PATCH
Update customer profile
{{baseUrl}}/api/dataentities/Client/documents/:id
HEADERS
Content-Type
Accept
QUERY PARAMS
id
BODY json
{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/Client/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/api/dataentities/Client/documents/:id" {:headers {:accept ""}
:content-type :json
:form-params {:document ""
:documentType ""
:email ""
:firstName ""
:isCorporate false
:isNewsletterOptIn false
:lastName ""
:localeDefault ""
:phone ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/Client/documents/:id"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
reqBody = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/Client/documents/:id"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/Client/documents/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddParameter("", "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/Client/documents/:id"
payload := strings.NewReader("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/api/dataentities/Client/documents/:id HTTP/1.1
Content-Type:
Accept:
Host: example.com
Content-Length: 186
{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/api/dataentities/Client/documents/:id")
.setHeader("content-type", "")
.setHeader("accept", "")
.setBody("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/Client/documents/:id"))
.header("content-type", "")
.header("accept", "")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/Client/documents/:id")
.patch(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/api/dataentities/Client/documents/:id")
.header("content-type", "")
.header("accept", "")
.body("{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
.asString();
const data = JSON.stringify({
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/api/dataentities/Client/documents/:id');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
headers: {'content-type': '', accept: ''},
data: {
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/Client/documents/:id';
const options = {
method: 'PATCH',
headers: {'content-type': '', accept: ''},
body: '{"document":"","documentType":"","email":"","firstName":"","isCorporate":false,"isNewsletterOptIn":false,"lastName":"","localeDefault":"","phone":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
method: 'PATCH',
headers: {
'content-type': '',
accept: ''
},
processData: false,
data: '{\n "document": "",\n "documentType": "",\n "email": "",\n "firstName": "",\n "isCorporate": false,\n "isNewsletterOptIn": false,\n "lastName": "",\n "localeDefault": "",\n "phone": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/Client/documents/:id")
.patch(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/Client/documents/:id',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
headers: {'content-type': '', accept: ''},
body: {
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/api/dataentities/Client/documents/:id');
req.headers({
'content-type': '',
accept: ''
});
req.type('json');
req.send({
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/Client/documents/:id',
headers: {'content-type': '', accept: ''},
data: {
document: '',
documentType: '',
email: '',
firstName: '',
isCorporate: false,
isNewsletterOptIn: false,
lastName: '',
localeDefault: '',
phone: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/Client/documents/:id';
const options = {
method: 'PATCH',
headers: {'content-type': '', accept: ''},
body: '{"document":"","documentType":"","email":"","firstName":"","isCorporate":false,"isNewsletterOptIn":false,"lastName":"","localeDefault":"","phone":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSDictionary *parameters = @{ @"document": @"",
@"documentType": @"",
@"email": @"",
@"firstName": @"",
@"isCorporate": @NO,
@"isNewsletterOptIn": @NO,
@"lastName": @"",
@"localeDefault": @"",
@"phone": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/Client/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/Client/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
let body = Cohttp_lwt_body.of_string "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/Client/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'document' => '',
'documentType' => '',
'email' => '',
'firstName' => '',
'isCorporate' => null,
'isNewsletterOptIn' => null,
'lastName' => '',
'localeDefault' => '',
'phone' => ''
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/api/dataentities/Client/documents/:id', [
'body' => '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}',
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/Client/documents/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'document' => '',
'documentType' => '',
'email' => '',
'firstName' => '',
'isCorporate' => null,
'isNewsletterOptIn' => null,
'lastName' => '',
'localeDefault' => '',
'phone' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'document' => '',
'documentType' => '',
'email' => '',
'firstName' => '',
'isCorporate' => null,
'isNewsletterOptIn' => null,
'lastName' => '',
'localeDefault' => '',
'phone' => ''
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/Client/documents/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/Client/documents/:id' -Method PATCH -Headers $headers -ContentType '' -Body '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}'
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/Client/documents/:id' -Method PATCH -Headers $headers -ContentType '' -Body '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
headers = {
'content-type': "",
'accept': ""
}
conn.request("PATCH", "/baseUrl/api/dataentities/Client/documents/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/Client/documents/:id"
payload = {
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": False,
"isNewsletterOptIn": False,
"lastName": "",
"localeDefault": "",
"phone": ""
}
headers = {
"content-type": "",
"accept": ""
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/Client/documents/:id"
payload <- "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/Client/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = ''
request["accept"] = ''
request.body = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/api/dataentities/Client/documents/:id') do |req|
req.headers['accept'] = ''
req.body = "{\n \"document\": \"\",\n \"documentType\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"isCorporate\": false,\n \"isNewsletterOptIn\": false,\n \"lastName\": \"\",\n \"localeDefault\": \"\",\n \"phone\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/Client/documents/:id";
let payload = json!({
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/api/dataentities/Client/documents/:id \
--header 'accept: ' \
--header 'content-type: ' \
--data '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}'
echo '{
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
}' | \
http PATCH {{baseUrl}}/api/dataentities/Client/documents/:id \
accept:'' \
content-type:''
wget --quiet \
--method PATCH \
--header 'content-type: ' \
--header 'accept: ' \
--body-data '{\n "document": "",\n "documentType": "",\n "email": "",\n "firstName": "",\n "isCorporate": false,\n "isNewsletterOptIn": false,\n "lastName": "",\n "localeDefault": "",\n "phone": ""\n}' \
--output-document \
- {{baseUrl}}/api/dataentities/Client/documents/:id
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let parameters = [
"document": "",
"documentType": "",
"email": "",
"firstName": "",
"isCorporate": false,
"isNewsletterOptIn": false,
"lastName": "",
"localeDefault": "",
"phone": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/Client/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
POST
Create new document
{{baseUrl}}/api/dataentities/:dataEntityName/documents
HEADERS
Content-Type
Accept
QUERY PARAMS
dataEntityName
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/api/dataentities/:dataEntityName/documents" {:headers {:accept ""}
:content-type :json})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddParameter("", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/api/dataentities/:dataEntityName/documents HTTP/1.1
Content-Type:
Accept:
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.setHeader("content-type", "")
.setHeader("accept", "")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents"))
.header("content-type", "")
.header("accept", "")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.post(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.header("content-type", "")
.header("accept", "")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/api/dataentities/:dataEntityName/documents');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
headers: {'content-type': '', accept: ''},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents';
const options = {method: 'POST', headers: {'content-type': '', accept: ''}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
method: 'POST',
headers: {
'content-type': '',
accept: ''
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.post(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
headers: {'content-type': '', accept: ''},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/api/dataentities/:dataEntityName/documents');
req.headers({
'content-type': '',
accept: ''
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
headers: {'content-type': '', accept: ''},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents';
const options = {method: 'POST', headers: {'content-type': '', accept: ''}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents",
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([
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/api/dataentities/:dataEntityName/documents', [
'body' => '{}',
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents' -Method POST -Headers $headers -ContentType '' -Body '{}'
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents' -Method POST -Headers $headers -ContentType '' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = {
'content-type': "",
'accept': ""
}
conn.request("POST", "/baseUrl/api/dataentities/:dataEntityName/documents", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
payload = {}
headers = {
"content-type": "",
"accept": ""
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = ''
request["accept"] = ''
request.body = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/api/dataentities/:dataEntityName/documents') do |req|
req.headers['accept'] = ''
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents \
--header 'accept: ' \
--header 'content-type: ' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/api/dataentities/:dataEntityName/documents \
accept:'' \
content-type:''
wget --quiet \
--method POST \
--header 'content-type: ' \
--header 'accept: ' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
PATCH
Create partial document
{{baseUrl}}/api/dataentities/:dataEntityName/documents
HEADERS
Content-Type
Accept
QUERY PARAMS
dataEntityName
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/api/dataentities/:dataEntityName/documents" {:headers {:accept ""}
:content-type :json})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
reqBody = "{}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddParameter("", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/api/dataentities/:dataEntityName/documents HTTP/1.1
Content-Type:
Accept:
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.setHeader("content-type", "")
.setHeader("accept", "")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents"))
.header("content-type", "")
.header("accept", "")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.patch(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.header("content-type", "")
.header("accept", "")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/api/dataentities/:dataEntityName/documents');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
headers: {'content-type': '', accept: ''},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents';
const options = {method: 'PATCH', headers: {'content-type': '', accept: ''}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
method: 'PATCH',
headers: {
'content-type': '',
accept: ''
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
.patch(body)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
headers: {'content-type': '', accept: ''},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/api/dataentities/:dataEntityName/documents');
req.headers({
'content-type': '',
accept: ''
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents',
headers: {'content-type': '', accept: ''},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents';
const options = {method: 'PATCH', headers: {'content-type': '', accept: ''}, body: '{}'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/api/dataentities/:dataEntityName/documents', [
'body' => '{}',
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents' -Method PATCH -Headers $headers -ContentType '' -Body '{}'
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents' -Method PATCH -Headers $headers -ContentType '' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = {
'content-type': "",
'accept': ""
}
conn.request("PATCH", "/baseUrl/api/dataentities/:dataEntityName/documents", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
payload = {}
headers = {
"content-type": "",
"accept": ""
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents"
payload <- "{}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = ''
request["accept"] = ''
request.body = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/api/dataentities/:dataEntityName/documents') do |req|
req.headers['accept'] = ''
req.body = "{}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents \
--header 'accept: ' \
--header 'content-type: ' \
--data '{}'
echo '{}' | \
http PATCH {{baseUrl}}/api/dataentities/:dataEntityName/documents \
accept:'' \
content-type:''
wget --quiet \
--method PATCH \
--header 'content-type: ' \
--header 'accept: ' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
DELETE
Delete document
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
HEADERS
Content-Type
Accept
QUERY PARAMS
dataEntityName
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" {:headers {:content-type ""
:accept ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"),
Headers =
{
{ "accept", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/api/dataentities/:dataEntityName/documents/:id HTTP/1.1
Content-Type:
Accept:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.setHeader("content-type", "")
.setHeader("accept", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"))
.header("content-type", "")
.header("accept", "")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.delete(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.header("content-type", "")
.header("accept", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {method: 'DELETE', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
method: 'DELETE',
headers: {
'content-type': '',
accept: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.delete(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {'content-type': '', accept: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
req.headers({
'content-type': '',
accept: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {method: 'DELETE', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id', [
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': ""
}
conn.request("DELETE", "/baseUrl/api/dataentities/:dataEntityName/documents/:id", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
headers = {
"content-type": "",
"accept": ""
}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = ''
request["accept"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/api/dataentities/:dataEntityName/documents/:id') do |req|
req.headers['accept'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
--header 'accept: ' \
--header 'content-type: '
http DELETE {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
accept:'' \
content-type:''
wget --quiet \
--method DELETE \
--header 'content-type: ' \
--header 'accept: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get document
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
HEADERS
Content-Type
Accept
QUERY PARAMS
dataEntityName
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" {:headers {:content-type ""
:accept ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"),
Headers =
{
{ "accept", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/documents/:id HTTP/1.1
Content-Type:
Accept:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.setHeader("content-type", "")
.setHeader("accept", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"))
.header("content-type", "")
.header("accept", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.header("content-type", "")
.header("accept", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {method: 'GET', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
method: 'GET',
headers: {
'content-type': '',
accept: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {'content-type': '', accept: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
req.headers({
'content-type': '',
accept: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {method: 'GET', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id', [
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': ""
}
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/documents/:id", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
headers = {
"content-type": "",
"accept": ""
}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
request["accept"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/documents/:id') do |req|
req.headers['accept'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
--header 'accept: ' \
--header 'content-type: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
accept:'' \
content-type:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--header 'accept: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"accountId": "14af940d-9300-4279-9355-61d44c2ff879",
"accountName": "my-store-name",
"dataEntityId": "Client",
"id": "b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
PUT
Update entire document
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
HEADERS
Accept
QUERY PARAMS
dataEntityName
id
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "accept: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" {:headers {:accept ""}
:content-type :json})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
headers = HTTP::Headers{
"accept" => ""
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
var request = new RestRequest("", Method.Put);
request.AddHeader("accept", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("accept", "")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/api/dataentities/:dataEntityName/documents/:id HTTP/1.1
Accept:
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.setHeader("accept", "")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"))
.header("accept", "")
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.put(body)
.addHeader("accept", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.header("accept", "")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
xhr.setRequestHeader('accept', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {accept: '', 'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {
method: 'PUT',
headers: {accept: '', 'content-type': 'application/json'},
body: '{}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
method: 'PUT',
headers: {
accept: '',
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.put(body)
.addHeader("accept", "")
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id',
headers: {
accept: '',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {accept: '', 'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
req.headers({
accept: '',
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {accept: '', 'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {
method: 'PUT',
headers: {accept: '', 'content-type': 'application/json'},
body: '{}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"accept": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("accept", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id', [
'body' => '{}',
'headers' => [
'accept' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'accept' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'accept' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("accept", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("accept", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = {
'accept': "",
'content-type': "application/json"
}
conn.request("PUT", "/baseUrl/api/dataentities/:dataEntityName/documents/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
payload = {}
headers = {
"accept": "",
"content-type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
payload <- "{}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["accept"] = ''
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/api/dataentities/:dataEntityName/documents/:id') do |req|
req.headers['accept'] = ''
req.body = "{}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("accept", "".parse().unwrap());
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
--header 'accept: ' \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http PUT {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
accept:'' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'accept: ' \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
import Foundation
let headers = [
"accept": "",
"content-type": "application/json"
]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
PATCH
Update partial document
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
HEADERS
Accept
QUERY PARAMS
dataEntityName
id
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "accept: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" {:headers {:accept ""}
:content-type :json})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
headers = HTTP::Headers{
"accept" => ""
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"),
Headers =
{
{ "accept", "" },
},
Content = new StringContent("{}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("accept", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("accept", "")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/api/dataentities/:dataEntityName/documents/:id HTTP/1.1
Accept:
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.setHeader("accept", "")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"))
.header("accept", "")
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.patch(body)
.addHeader("accept", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.header("accept", "")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
xhr.setRequestHeader('accept', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {accept: '', 'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {
method: 'PATCH',
headers: {accept: '', 'content-type': 'application/json'},
body: '{}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
method: 'PATCH',
headers: {
accept: '',
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
.patch(body)
.addHeader("accept", "")
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id',
headers: {
accept: '',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {accept: '', 'content-type': 'application/json'},
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
req.headers({
accept: '',
'content-type': 'application/json'
});
req.type('json');
req.send({});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id',
headers: {accept: '', 'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id';
const options = {
method: 'PATCH',
headers: {accept: '', 'content-type': 'application/json'},
body: '{}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"accept": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id" in
let headers = Header.add_list (Header.init ()) [
("accept", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id', [
'body' => '{}',
'headers' => [
'accept' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'accept' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'accept' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("accept", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("accept", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = {
'accept': "",
'content-type': "application/json"
}
conn.request("PATCH", "/baseUrl/api/dataentities/:dataEntityName/documents/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
payload = {}
headers = {
"accept": "",
"content-type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id"
payload <- "{}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["accept"] = ''
request["content-type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/api/dataentities/:dataEntityName/documents/:id') do |req|
req.headers['accept'] = ''
req.body = "{}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("accept", "".parse().unwrap());
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
--header 'accept: ' \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http PATCH {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id \
accept:'' \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'accept: ' \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id
import Foundation
let headers = [
"accept": "",
"content-type": "application/json"
]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}
DELETE
Delete index by name
{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name
HEADERS
Content-Type
QUERY PARAMS
dataEntityName
index_name
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name" {:headers {:content-type ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
headers = HTTP::Headers{
"content-type" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("content-type", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/api/dataentities/:dataEntityName/indices/:index_name HTTP/1.1
Content-Type:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.setHeader("content-type", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"))
.header("content-type", "")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.delete(null)
.addHeader("content-type", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.header("content-type", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
xhr.setRequestHeader('content-type', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name';
const options = {method: 'DELETE', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
method: 'DELETE',
headers: {
'content-type': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.delete(null)
.addHeader("content-type", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/indices/:index_name',
headers: {
'content-type': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
headers: {'content-type': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
req.headers({
'content-type': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name';
const options = {method: 'DELETE', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name" in
let headers = Header.add (Header.init ()) "content-type" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name', [
'headers' => [
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'content-type' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'content-type': "" }
conn.request("DELETE", "/baseUrl/api/dataentities/:dataEntityName/indices/:index_name", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
headers = {"content-type": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/api/dataentities/:dataEntityName/indices/:index_name') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name \
--header 'content-type: '
http DELETE {{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name \
content-type:''
wget --quiet \
--method DELETE \
--header 'content-type: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name
import Foundation
let headers = ["content-type": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get index by name
{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name
HEADERS
Content-Type
QUERY PARAMS
dataEntityName
index_name
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name" {:headers {:content-type ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
headers = HTTP::Headers{
"content-type" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/indices/:index_name HTTP/1.1
Content-Type:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.setHeader("content-type", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"))
.header("content-type", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.get()
.addHeader("content-type", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.header("content-type", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
xhr.setRequestHeader('content-type', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
method: 'GET',
headers: {
'content-type': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
.get()
.addHeader("content-type", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/indices/:index_name',
headers: {
'content-type': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
headers: {'content-type': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
req.headers({
'content-type': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name" in
let headers = Header.add (Header.init ()) "content-type" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name', [
'headers' => [
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'content-type': "" }
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/indices/:index_name", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
headers = {"content-type": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/indices/:index_name') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name \
--header 'content-type: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name \
content-type:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name
import Foundation
let headers = ["content-type": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/indices/:index_name")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get indices
{{baseUrl}}/api/dataentities/:dataEntityName/indices
HEADERS
Content-Type
QUERY PARAMS
dataEntityName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/indices");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/indices" {:headers {:content-type ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
headers = HTTP::Headers{
"content-type" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/indices"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/indices");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/indices HTTP/1.1
Content-Type:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.setHeader("content-type", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/indices"))
.header("content-type", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.get()
.addHeader("content-type", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.header("content-type", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/indices');
xhr.setRequestHeader('content-type', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
method: 'GET',
headers: {
'content-type': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.get()
.addHeader("content-type", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/indices',
headers: {
'content-type': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
headers: {'content-type': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/indices');
req.headers({
'content-type': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/indices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/indices" in
let headers = Header.add (Header.init ()) "content-type" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/indices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/indices', [
'headers' => [
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'content-type': "" }
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/indices", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
headers = {"content-type": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/indices') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/indices \
--header 'content-type: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/indices \
content-type:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/indices
import Foundation
let headers = ["content-type": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/indices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Put indices
{{baseUrl}}/api/dataentities/:dataEntityName/indices
QUERY PARAMS
dataEntityName
BODY json
{
"fields": "",
"multiple": false,
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/indices");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/api/dataentities/:dataEntityName/indices" {:content-type :json
:form-params {:fields "fieldName"
:multiple false
:name "indexName"}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/indices"),
Content = new StringContent("{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/indices");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
payload := strings.NewReader("{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}")
req, _ := http.NewRequest("PUT", 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(res)
fmt.Println(string(body))
}
PUT /baseUrl/api/dataentities/:dataEntityName/indices HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 71
{
"fields": "fieldName",
"multiple": false,
"name": "indexName"
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.setHeader("content-type", "application/json")
.setBody("{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/indices"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.header("content-type", "application/json")
.body("{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}")
.asString();
const data = JSON.stringify({
fields: 'fieldName',
multiple: false,
name: 'indexName'
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/indices');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
headers: {'content-type': 'application/json'},
data: {fields: 'fieldName', multiple: false, name: 'indexName'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fields":"fieldName","multiple":false,"name":"indexName"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fields": "fieldName",\n "multiple": false,\n "name": "indexName"\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/indices',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({fields: 'fieldName', multiple: false, name: 'indexName'}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
headers: {'content-type': 'application/json'},
body: {fields: 'fieldName', multiple: false, name: 'indexName'},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/indices');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fields: 'fieldName',
multiple: false,
name: 'indexName'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/indices',
headers: {'content-type': 'application/json'},
data: {fields: 'fieldName', multiple: false, name: 'indexName'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/indices';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fields":"fieldName","multiple":false,"name":"indexName"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"fields": @"fieldName",
@"multiple": @NO,
@"name": @"indexName" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/indices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/indices" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/indices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'fields' => 'fieldName',
'multiple' => null,
'name' => 'indexName'
]),
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;
}
request('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/indices', [
'body' => '{
"fields": "fieldName",
"multiple": false,
"name": "indexName"
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fields' => 'fieldName',
'multiple' => null,
'name' => 'indexName'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fields' => 'fieldName',
'multiple' => null,
'name' => 'indexName'
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/indices');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fields": "fieldName",
"multiple": false,
"name": "indexName"
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/indices' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fields": "fieldName",
"multiple": false,
"name": "indexName"
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/api/dataentities/:dataEntityName/indices", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
payload = {
"fields": "fieldName",
"multiple": False,
"name": "indexName"
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/indices"
payload <- "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/indices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/api/dataentities/:dataEntityName/indices') do |req|
req.body = "{\n \"fields\": \"fieldName\",\n \"multiple\": false,\n \"name\": \"indexName\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/indices";
let payload = json!({
"fields": "fieldName",
"multiple": false,
"name": "indexName"
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/api/dataentities/:dataEntityName/indices \
--header 'content-type: application/json' \
--data '{
"fields": "fieldName",
"multiple": false,
"name": "indexName"
}'
echo '{
"fields": "fieldName",
"multiple": false,
"name": "indexName"
}' | \
http PUT {{baseUrl}}/api/dataentities/:dataEntityName/indices \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fields": "fieldName",\n "multiple": false,\n "name": "indexName"\n}' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/indices
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fields": "fieldName",
"multiple": false,
"name": "indexName"
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/indices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete schema by name
{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName
HEADERS
Content-Type
QUERY PARAMS
dataEntityName
schemaName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName" {:headers {:content-type ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
headers = HTTP::Headers{
"content-type" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("content-type", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName HTTP/1.1
Content-Type:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.setHeader("content-type", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"))
.header("content-type", "")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.delete(null)
.addHeader("content-type", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.header("content-type", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
xhr.setRequestHeader('content-type', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName';
const options = {method: 'DELETE', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
method: 'DELETE',
headers: {
'content-type': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.delete(null)
.addHeader("content-type", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {
'content-type': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
req.headers({
'content-type': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName';
const options = {method: 'DELETE', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName" in
let headers = Header.add (Header.init ()) "content-type" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName', [
'headers' => [
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'content-type' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'content-type': "" }
conn.request("DELETE", "/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
headers = {"content-type": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName \
--header 'content-type: '
http DELETE {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName \
content-type:''
wget --quiet \
--method DELETE \
--header 'content-type: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName
import Foundation
let headers = ["content-type": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get schema by name
{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName
HEADERS
Content-Type
QUERY PARAMS
dataEntityName
schemaName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName" {:headers {:content-type ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
headers = HTTP::Headers{
"content-type" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName HTTP/1.1
Content-Type:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.setHeader("content-type", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"))
.header("content-type", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.get()
.addHeader("content-type", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.header("content-type", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
xhr.setRequestHeader('content-type', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
method: 'GET',
headers: {
'content-type': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.get()
.addHeader("content-type", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {
'content-type': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
req.headers({
'content-type': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName" in
let headers = Header.add (Header.init ()) "content-type" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName', [
'headers' => [
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'content-type': "" }
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
headers = {"content-type": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName \
--header 'content-type: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName \
content-type:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName
import Foundation
let headers = ["content-type": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get schemas
{{baseUrl}}/api/dataentities/:dataEntityName/schemas
HEADERS
Content-Type
QUERY PARAMS
dataEntityName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/schemas");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/schemas" {:headers {:content-type ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas"
headers = HTTP::Headers{
"content-type" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/schemas"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/schemas");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/schemas"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/schemas HTTP/1.1
Content-Type:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/schemas")
.setHeader("content-type", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/schemas"))
.header("content-type", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas")
.get()
.addHeader("content-type", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/schemas")
.header("content-type", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas');
xhr.setRequestHeader('content-type', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas',
method: 'GET',
headers: {
'content-type': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas")
.get()
.addHeader("content-type", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/schemas',
headers: {
'content-type': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas',
headers: {'content-type': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas');
req.headers({
'content-type': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas',
headers: {'content-type': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas';
const options = {method: 'GET', headers: {'content-type': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/schemas"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/schemas" in
let headers = Header.add (Header.init ()) "content-type" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/schemas",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas', [
'headers' => [
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'content-type': "" }
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/schemas", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas"
headers = {"content-type": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/schemas"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/schemas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/schemas') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/schemas \
--header 'content-type: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/schemas \
content-type:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/schemas
import Foundation
let headers = ["content-type": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/schemas")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Save schema by name
{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName
QUERY PARAMS
dataEntityName
schemaName
BODY json
{
"properties": {
"name": {
"type": ""
}
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName" {:content-type :json
:form-params {:properties {:name {:type "string"}}}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"),
Content = new StringContent("{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
payload := strings.NewReader("{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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(res)
fmt.Println(string(body))
}
PUT /baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 68
{
"properties": {
"name": {
"type": "string"
}
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.setHeader("content-type", "application/json")
.setBody("{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.header("content-type", "application/json")
.body("{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}")
.asString();
const data = JSON.stringify({
properties: {
name: {
type: 'string'
}
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': 'application/json'},
data: {properties: {name: {type: 'string'}}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"properties":{"name":{"type":"string"}}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "properties": {\n "name": {\n "type": "string"\n }\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({properties: {name: {type: 'string'}}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': 'application/json'},
body: {properties: {name: {type: 'string'}}},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
properties: {
name: {
type: 'string'
}
}
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName',
headers: {'content-type': 'application/json'},
data: {properties: {name: {type: 'string'}}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"properties":{"name":{"type":"string"}}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"properties": @{ @"name": @{ @"type": @"string" } } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'properties' => [
'name' => [
'type' => '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;
}
request('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName', [
'body' => '{
"properties": {
"name": {
"type": "string"
}
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'properties' => [
'name' => [
'type' => 'string'
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'properties' => [
'name' => [
'type' => 'string'
]
]
]));
$request->setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"properties": {
"name": {
"type": "string"
}
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"properties": {
"name": {
"type": "string"
}
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
payload = { "properties": { "name": { "type": "string" } } }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName"
payload <- "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/api/dataentities/:dataEntityName/schemas/:schemaName') do |req|
req.body = "{\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n }\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName";
let payload = json!({"properties": json!({"name": json!({"type": "string"})})});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName \
--header 'content-type: application/json' \
--data '{
"properties": {
"name": {
"type": "string"
}
}
}'
echo '{
"properties": {
"name": {
"type": "string"
}
}
}' | \
http PUT {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "properties": {\n "name": {\n "type": "string"\n }\n }\n}' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["properties": ["name": ["type": "string"]]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/schemas/:schemaName")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Scroll documents
{{baseUrl}}/api/dataentities/:dataEntityName/scroll
HEADERS
Content-Type
Accept
REST-Range
QUERY PARAMS
dataEntityName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/scroll");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
headers = curl_slist_append(headers, "rest-range: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/scroll" {:headers {:content-type ""
:accept ""
:rest-range ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/scroll"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
"rest-range" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/scroll"),
Headers =
{
{ "accept", "" },
{ "rest-range", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/scroll");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddHeader("rest-range", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/scroll"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
req.Header.Add("rest-range", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/scroll HTTP/1.1
Content-Type:
Accept:
Rest-Range:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/scroll")
.setHeader("content-type", "")
.setHeader("accept", "")
.setHeader("rest-range", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/scroll"))
.header("content-type", "")
.header("accept", "")
.header("rest-range", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/scroll")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.addHeader("rest-range", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/scroll")
.header("content-type", "")
.header("accept", "")
.header("rest-range", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/scroll');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.setRequestHeader('rest-range', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/scroll',
headers: {'content-type': '', accept: '', 'rest-range': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/scroll';
const options = {method: 'GET', headers: {'content-type': '', accept: '', 'rest-range': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/scroll',
method: 'GET',
headers: {
'content-type': '',
accept: '',
'rest-range': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/scroll")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.addHeader("rest-range", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/scroll',
headers: {
'content-type': '',
accept: '',
'rest-range': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/scroll',
headers: {'content-type': '', accept: '', 'rest-range': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/scroll');
req.headers({
'content-type': '',
accept: '',
'rest-range': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/scroll',
headers: {'content-type': '', accept: '', 'rest-range': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/scroll';
const options = {method: 'GET', headers: {'content-type': '', accept: '', 'rest-range': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"",
@"rest-range": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/scroll"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/scroll" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
("rest-range", "");
] in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/scroll",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: ",
"rest-range: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/scroll', [
'headers' => [
'accept' => '',
'content-type' => '',
'rest-range' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/scroll');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => '',
'accept' => '',
'rest-range' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/scroll');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => '',
'accept' => '',
'rest-range' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$headers.Add("rest-range", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/scroll' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$headers.Add("rest-range", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/scroll' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': "",
'rest-range': ""
}
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/scroll", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/scroll"
headers = {
"content-type": "",
"accept": "",
"rest-range": ""
}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/scroll"
response <- VERB("GET", url, add_headers('rest-range' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/scroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
request["accept"] = ''
request["rest-range"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/scroll') do |req|
req.headers['accept'] = ''
req.headers['rest-range'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/scroll";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
headers.insert("rest-range", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/scroll \
--header 'accept: ' \
--header 'content-type: ' \
--header 'rest-range: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/scroll \
accept:'' \
content-type:'' \
rest-range:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--header 'accept: ' \
--header 'rest-range: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/scroll
import Foundation
let headers = [
"content-type": "",
"accept": "",
"rest-range": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/scroll")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{}
GET
Search documents
{{baseUrl}}/api/dataentities/:dataEntityName/search
HEADERS
Content-Type
Accept
REST-Range
QUERY PARAMS
dataEntityName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/search");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
headers = curl_slist_append(headers, "rest-range: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/search" {:headers {:content-type ""
:accept ""
:rest-range ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/search"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
"rest-range" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/search"),
Headers =
{
{ "accept", "" },
{ "rest-range", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/search");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
request.AddHeader("rest-range", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
req.Header.Add("rest-range", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/search HTTP/1.1
Content-Type:
Accept:
Rest-Range:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/search")
.setHeader("content-type", "")
.setHeader("accept", "")
.setHeader("rest-range", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/search"))
.header("content-type", "")
.header("accept", "")
.header("rest-range", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/search")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.addHeader("rest-range", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/search")
.header("content-type", "")
.header("accept", "")
.header("rest-range", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/search');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.setRequestHeader('rest-range', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/search',
headers: {'content-type': '', accept: '', 'rest-range': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/search';
const options = {method: 'GET', headers: {'content-type': '', accept: '', 'rest-range': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/search',
method: 'GET',
headers: {
'content-type': '',
accept: '',
'rest-range': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/search")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.addHeader("rest-range", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/search',
headers: {
'content-type': '',
accept: '',
'rest-range': ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/search',
headers: {'content-type': '', accept: '', 'rest-range': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/search');
req.headers({
'content-type': '',
accept: '',
'rest-range': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/search',
headers: {'content-type': '', accept: '', 'rest-range': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/search';
const options = {method: 'GET', headers: {'content-type': '', accept: '', 'rest-range': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"",
@"rest-range": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/search"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/search" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
("rest-range", "");
] in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: ",
"rest-range: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/search', [
'headers' => [
'accept' => '',
'content-type' => '',
'rest-range' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/search');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => '',
'accept' => '',
'rest-range' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/search');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => '',
'accept' => '',
'rest-range' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$headers.Add("rest-range", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/search' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$headers.Add("rest-range", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/search' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': "",
'rest-range': ""
}
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/search", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/search"
headers = {
"content-type": "",
"accept": "",
"rest-range": ""
}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/search"
response <- VERB("GET", url, add_headers('rest-range' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
request["accept"] = ''
request["rest-range"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/search') do |req|
req.headers['accept'] = ''
req.headers['rest-range'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/search";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
headers.insert("rest-range", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/search \
--header 'accept: ' \
--header 'content-type: ' \
--header 'rest-range: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/search \
accept:'' \
content-type:'' \
rest-range:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--header 'accept: ' \
--header 'rest-range: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/search
import Foundation
let headers = [
"content-type": "",
"accept": "",
"rest-range": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/search")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{}
GET
Get version
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId
HEADERS
Content-Type
Accept
QUERY PARAMS
dataEntityName
id
versionId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId" {:headers {:content-type ""
:accept ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"),
Headers =
{
{ "accept", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId HTTP/1.1
Content-Type:
Accept:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.setHeader("content-type", "")
.setHeader("accept", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"))
.header("content-type", "")
.header("accept", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.header("content-type", "")
.header("accept", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId';
const options = {method: 'GET', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
method: 'GET',
headers: {
'content-type': '',
accept: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {'content-type': '', accept: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
req.headers({
'content-type': '',
accept: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId';
const options = {method: 'GET', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId', [
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': ""
}
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
headers = {
"content-type": "",
"accept": ""
}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
request["accept"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId') do |req|
req.headers['accept'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId \
--header 'accept: ' \
--header 'content-type: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId \
accept:'' \
content-type:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--header 'accept: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"author": "user-id",
"document": {
"accountId": "my-account-id",
"accountName": "my-account",
"carttag": null,
"checkouttag": null,
"dataEntityId": "Client",
"departmentVisitedTag": {
"DisplayValue": "Ar e Ventilação",
"Scores": {
"Ar e Ventilação": [
{
"Date": "2016-10-18T16:53:31.0842607Z",
"Point": 1,
"Until": "2017-04-16T16:53:31.0842607Z"
}
]
}
},
"email": "teste@mail.com",
"followers": [],
"id": "my-id",
"rclastsession": "163054c0-954f-11e6-891e-4d2b1c3450a4",
"rclastsessiondate": "2016-10-18T16:53:00"
},
"id": "version-id"
}
GET
List versions
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions
HEADERS
Content-Type
Accept
QUERY PARAMS
dataEntityName
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions" {:headers {:content-type ""
:accept ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions"),
Headers =
{
{ "accept", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions");
var request = new RestRequest("", Method.Get);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/api/dataentities/:dataEntityName/documents/:id/versions HTTP/1.1
Content-Type:
Accept:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions")
.setHeader("content-type", "")
.setHeader("accept", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions"))
.header("content-type", "")
.header("accept", "")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions")
.header("content-type", "")
.header("accept", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions';
const options = {method: 'GET', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions',
method: 'GET',
headers: {
'content-type': '',
accept: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions")
.get()
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions',
headers: {'content-type': '', accept: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions');
req.headers({
'content-type': '',
accept: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions';
const options = {method: 'GET', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions', [
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions');
$request->setRequestMethod('GET');
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions' -Method GET -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': ""
}
conn.request("GET", "/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions"
headers = {
"content-type": "",
"accept": ""
}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["content-type"] = ''
request["accept"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions') do |req|
req.headers['accept'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions \
--header 'accept: ' \
--header 'content-type: '
http GET {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions \
accept:'' \
content-type:''
wget --quiet \
--method GET \
--header 'content-type: ' \
--header 'accept: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"date": "2016-10-18T16:53:32+00:00",
"document": {
"createdBy": "81fc8b10-25b7-48de-b425-7b93554002cc",
"dataEntityId": "Client",
"id": "72e7f8dd-1168-23ec-82ac-0e2b61663eb4",
"isNewsletterOptIn": true
},
"id": "_EAR0cJ7XB5k5grnmm0zeKGlVvVM9WCPy_"
},
{
"date": "2016-09-08T20:11:42+00:00",
"document": {
"createdBy": "81fc8b10-25b7-48de-b425-7b93554002cc",
"dataEntityId": "Client",
"id": "72e7f8dd-1168-23ec-82ac-0e2b61663eb4",
"isNewsletterOptIn": true
},
"id": "_E5SH9WXVvhPBNnbQtYAAGqrIysIeNYhV_"
}
]
PUT
Put version
{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId
HEADERS
Content-Type
Accept
QUERY PARAMS
dataEntityName
id
versionId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: ");
headers = curl_slist_append(headers, "accept: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId" {:headers {:content-type ""
:accept ""}})
require "http/client"
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
headers = HTTP::Headers{
"content-type" => ""
"accept" => ""
}
response = HTTP::Client.put url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"),
Headers =
{
{ "accept", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "");
request.AddHeader("accept", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("content-type", "")
req.Header.Add("accept", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId HTTP/1.1
Content-Type:
Accept:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.setHeader("content-type", "")
.setHeader("accept", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"))
.header("content-type", "")
.header("accept", "")
.method("PUT", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.put(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.header("content-type", "")
.header("accept", "")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
xhr.setRequestHeader('content-type', '');
xhr.setRequestHeader('accept', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId';
const options = {method: 'PUT', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
method: 'PUT',
headers: {
'content-type': '',
accept: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
.put(null)
.addHeader("content-type", "")
.addHeader("accept", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {
'content-type': '',
accept: ''
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {'content-type': '', accept: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
req.headers({
'content-type': '',
accept: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId',
headers: {'content-type': '', accept: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId';
const options = {method: 'PUT', headers: {'content-type': '', accept: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"",
@"accept": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId" in
let headers = Header.add_list (Header.init ()) [
("content-type", "");
("accept", "");
] in
Client.call ~headers `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"accept: ",
"content-type: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId', [
'headers' => [
'accept' => '',
'content-type' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId');
$request->setRequestMethod('PUT');
$request->setHeaders([
'content-type' => '',
'accept' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId' -Method PUT -Headers $headers
$headers=@{}
$headers.Add("content-type", "")
$headers.Add("accept", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId' -Method PUT -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'content-type': "",
'accept': ""
}
conn.request("PUT", "/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
headers = {
"content-type": "",
"accept": ""
}
response = requests.put(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = ''
request["accept"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/api/dataentities/:dataEntityName/documents/:id/versions/:versionId') do |req|
req.headers['accept'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "".parse().unwrap());
headers.insert("accept", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId \
--header 'accept: ' \
--header 'content-type: '
http PUT {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId \
accept:'' \
content-type:''
wget --quiet \
--method PUT \
--header 'content-type: ' \
--header 'accept: ' \
--output-document \
- {{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId
import Foundation
let headers = [
"content-type": "",
"accept": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/api/dataentities/:dataEntityName/documents/:id/versions/:versionId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"Href": "http://api.vtex.com/my-store-name/dataentities/Client/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
"Id": "Client-b818cbda-e489-11e6-94f4-0ac138d2d42e"
}