Box Platform API
Box Platform APIv2.0.0
Box Platform provides functionality to provide access to content stored within Box. It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
- Endpoints
- 260 (114 GET, 61 POST, 42 PUT, 41 DELETE)
- Base URL
https://api.box.com/2.0- Authentication
- OAuth 2.0
- Spec format
- OpenAPI 3.0.2
- API version
- 2.0.0
- Source
- opensource.box.com
- Provider
- box.com
- License
- Apache-2.0
- Categories
- Cloud & Infrastructure
- 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://api.box.com/2.0) and your OAuth 2.0 credentials, then send requests.
GET
Authorize user
{{baseUrl}}/authorize
QUERY PARAMS
response_type
client_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/authorize?response_type=&client_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/authorize" {:query-params {:response_type ""
:client_id ""}})
require "http/client"
url = "{{baseUrl}}/authorize?response_type=&client_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/authorize?response_type=&client_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/authorize?response_type=&client_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/authorize?response_type=&client_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/authorize?response_type=&client_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/authorize?response_type=&client_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/authorize?response_type=&client_id="))
.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}}/authorize?response_type=&client_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/authorize?response_type=&client_id=")
.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}}/authorize?response_type=&client_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/authorize',
params: {response_type: '', client_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/authorize?response_type=&client_id=';
const options = {method: 'GET'};
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}}/authorize?response_type=&client_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/authorize?response_type=&client_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/authorize?response_type=&client_id=',
headers: {}
};
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}}/authorize',
qs: {response_type: '', client_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/authorize');
req.query({
response_type: '',
client_id: ''
});
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}}/authorize',
params: {response_type: '', client_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/authorize?response_type=&client_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/authorize?response_type=&client_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/authorize?response_type=&client_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/authorize?response_type=&client_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/authorize?response_type=&client_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/authorize');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'response_type' => '',
'client_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/authorize');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'response_type' => '',
'client_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/authorize?response_type=&client_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/authorize?response_type=&client_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/authorize?response_type=&client_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/authorize"
querystring = {"response_type":"","client_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/authorize"
queryString <- list(
response_type = "",
client_id = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/authorize?response_type=&client_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/authorize') do |req|
req.params['response_type'] = ''
req.params['client_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/authorize";
let querystring = [
("response_type", ""),
("client_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/authorize?response_type=&client_id='
http GET '{{baseUrl}}/authorize?response_type=&client_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/authorize?response_type=&client_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/authorize?response_type=&client_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Refresh access token
{{baseUrl}}/oauth2/token#refresh
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/oauth2/token#refresh");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/oauth2/token#refresh")
require "http/client"
url = "{{baseUrl}}/oauth2/token#refresh"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/oauth2/token#refresh"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/oauth2/token#refresh");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/oauth2/token#refresh"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/oauth2/token HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/oauth2/token#refresh")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/oauth2/token#refresh"))
.method("POST", 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}}/oauth2/token#refresh")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/oauth2/token#refresh")
.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('POST', '{{baseUrl}}/oauth2/token#refresh');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/oauth2/token#refresh'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/oauth2/token#refresh';
const options = {method: 'POST'};
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}}/oauth2/token#refresh',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/oauth2/token#refresh")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/oauth2/token',
headers: {}
};
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: 'POST', url: '{{baseUrl}}/oauth2/token#refresh'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/oauth2/token#refresh');
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}}/oauth2/token#refresh'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/oauth2/token#refresh';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/oauth2/token#refresh"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
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}}/oauth2/token#refresh" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/oauth2/token#refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/oauth2/token#refresh');
echo $response->getBody();
setUrl('{{baseUrl}}/oauth2/token#refresh');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/oauth2/token#refresh');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/oauth2/token#refresh' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/oauth2/token#refresh' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/oauth2/token")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/oauth2/token#refresh"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/oauth2/token#refresh"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/oauth2/token#refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/oauth2/token') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/oauth2/token#refresh";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url '{{baseUrl}}/oauth2/token#refresh'
http POST '{{baseUrl}}/oauth2/token#refresh'
wget --quiet \
--method POST \
--output-document \
- '{{baseUrl}}/oauth2/token#refresh'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/oauth2/token#refresh")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
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
Request access token
{{baseUrl}}/oauth2/token
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/oauth2/token");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/oauth2/token")
require "http/client"
url = "{{baseUrl}}/oauth2/token"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/oauth2/token"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/oauth2/token");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/oauth2/token"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/oauth2/token HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/oauth2/token")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/oauth2/token"))
.method("POST", 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}}/oauth2/token")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/oauth2/token")
.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('POST', '{{baseUrl}}/oauth2/token');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/oauth2/token'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/oauth2/token';
const options = {method: 'POST'};
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}}/oauth2/token',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/oauth2/token")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/oauth2/token',
headers: {}
};
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: 'POST', url: '{{baseUrl}}/oauth2/token'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/oauth2/token');
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}}/oauth2/token'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/oauth2/token';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/oauth2/token"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
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}}/oauth2/token" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/oauth2/token",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/oauth2/token');
echo $response->getBody();
setUrl('{{baseUrl}}/oauth2/token');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/oauth2/token');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/oauth2/token' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/oauth2/token' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/oauth2/token")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/oauth2/token"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/oauth2/token"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/oauth2/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/oauth2/token') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/oauth2/token";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/oauth2/token
http POST {{baseUrl}}/oauth2/token
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/oauth2/token
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/oauth2/token")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
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
Revoke access token
{{baseUrl}}/oauth2/revoke
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/oauth2/revoke");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/oauth2/revoke")
require "http/client"
url = "{{baseUrl}}/oauth2/revoke"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/oauth2/revoke"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/oauth2/revoke");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/oauth2/revoke"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/oauth2/revoke HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/oauth2/revoke")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/oauth2/revoke"))
.method("POST", 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}}/oauth2/revoke")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/oauth2/revoke")
.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('POST', '{{baseUrl}}/oauth2/revoke');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/oauth2/revoke'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/oauth2/revoke';
const options = {method: 'POST'};
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}}/oauth2/revoke',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/oauth2/revoke")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/oauth2/revoke',
headers: {}
};
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: 'POST', url: '{{baseUrl}}/oauth2/revoke'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/oauth2/revoke');
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}}/oauth2/revoke'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/oauth2/revoke';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/oauth2/revoke"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
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}}/oauth2/revoke" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/oauth2/revoke",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/oauth2/revoke');
echo $response->getBody();
setUrl('{{baseUrl}}/oauth2/revoke');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/oauth2/revoke');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/oauth2/revoke' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/oauth2/revoke' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/oauth2/revoke")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/oauth2/revoke"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/oauth2/revoke"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/oauth2/revoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/oauth2/revoke') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/oauth2/revoke";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/oauth2/revoke
http POST {{baseUrl}}/oauth2/revoke
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/oauth2/revoke
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/oauth2/revoke")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
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
Cancel sign request
{{baseUrl}}/sign_requests/:sign_request_id/cancel
QUERY PARAMS
sign_request_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sign_requests/:sign_request_id/cancel");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sign_requests/:sign_request_id/cancel")
require "http/client"
url = "{{baseUrl}}/sign_requests/:sign_request_id/cancel"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sign_requests/:sign_request_id/cancel"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sign_requests/:sign_request_id/cancel");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sign_requests/:sign_request_id/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sign_requests/:sign_request_id/cancel HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sign_requests/:sign_request_id/cancel")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sign_requests/:sign_request_id/cancel"))
.method("POST", 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}}/sign_requests/:sign_request_id/cancel")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sign_requests/:sign_request_id/cancel")
.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('POST', '{{baseUrl}}/sign_requests/:sign_request_id/cancel');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sign_requests/:sign_request_id/cancel'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sign_requests/:sign_request_id/cancel';
const options = {method: 'POST'};
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}}/sign_requests/:sign_request_id/cancel',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sign_requests/:sign_request_id/cancel")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sign_requests/:sign_request_id/cancel',
headers: {}
};
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: 'POST',
url: '{{baseUrl}}/sign_requests/:sign_request_id/cancel'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sign_requests/:sign_request_id/cancel');
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}}/sign_requests/:sign_request_id/cancel'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sign_requests/:sign_request_id/cancel';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sign_requests/:sign_request_id/cancel"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
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}}/sign_requests/:sign_request_id/cancel" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sign_requests/:sign_request_id/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sign_requests/:sign_request_id/cancel');
echo $response->getBody();
setUrl('{{baseUrl}}/sign_requests/:sign_request_id/cancel');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sign_requests/:sign_request_id/cancel');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sign_requests/:sign_request_id/cancel' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sign_requests/:sign_request_id/cancel' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/sign_requests/:sign_request_id/cancel")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sign_requests/:sign_request_id/cancel"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sign_requests/:sign_request_id/cancel"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sign_requests/:sign_request_id/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sign_requests/:sign_request_id/cancel') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sign_requests/:sign_request_id/cancel";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sign_requests/:sign_request_id/cancel
http POST {{baseUrl}}/sign_requests/:sign_request_id/cancel
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sign_requests/:sign_request_id/cancel
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sign_requests/:sign_request_id/cancel")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create sign request
{{baseUrl}}/sign_requests
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sign_requests");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sign_requests" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/sign_requests"
headers = HTTP::Headers{
"content-type" => "application/json"
}
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}}/sign_requests"),
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}}/sign_requests");
var request = new RestRequest("", Method.Post);
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}}/sign_requests"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sign_requests HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sign_requests")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sign_requests"))
.header("content-type", "application/json")
.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}}/sign_requests")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sign_requests")
.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('POST', '{{baseUrl}}/sign_requests');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sign_requests',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sign_requests';
const options = {method: 'POST', headers: {'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}}/sign_requests',
method: 'POST',
headers: {
'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}}/sign_requests")
.post(body)
.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/sign_requests',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sign_requests',
headers: {'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('POST', '{{baseUrl}}/sign_requests');
req.headers({
'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: 'POST',
url: '{{baseUrl}}/sign_requests',
headers: {'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}}/sign_requests';
const options = {method: 'POST', headers: {'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 = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sign_requests"]
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}}/sign_requests" in
let headers = Header.add (Header.init ()) "content-type" "application/json" 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}}/sign_requests",
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 => [
"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}}/sign_requests', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sign_requests');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'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}}/sign_requests');
$request->setRequestMethod('POST');
$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}}/sign_requests' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sign_requests' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/sign_requests", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sign_requests"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sign_requests"
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}}/sign_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
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/sign_requests') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sign_requests";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
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}}/sign_requests \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/sign_requests \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/sign_requests
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sign_requests")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get sign request by ID
{{baseUrl}}/sign_requests/:sign_request_id
QUERY PARAMS
sign_request_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sign_requests/:sign_request_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sign_requests/:sign_request_id")
require "http/client"
url = "{{baseUrl}}/sign_requests/:sign_request_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sign_requests/:sign_request_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sign_requests/:sign_request_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sign_requests/:sign_request_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sign_requests/:sign_request_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sign_requests/:sign_request_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sign_requests/:sign_request_id"))
.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}}/sign_requests/:sign_request_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sign_requests/:sign_request_id")
.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}}/sign_requests/:sign_request_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/sign_requests/:sign_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sign_requests/:sign_request_id';
const options = {method: 'GET'};
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}}/sign_requests/:sign_request_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sign_requests/:sign_request_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sign_requests/:sign_request_id',
headers: {}
};
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}}/sign_requests/:sign_request_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sign_requests/:sign_request_id');
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}}/sign_requests/:sign_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sign_requests/:sign_request_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sign_requests/:sign_request_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/sign_requests/:sign_request_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sign_requests/:sign_request_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sign_requests/:sign_request_id');
echo $response->getBody();
setUrl('{{baseUrl}}/sign_requests/:sign_request_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sign_requests/:sign_request_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sign_requests/:sign_request_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sign_requests/:sign_request_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sign_requests/:sign_request_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sign_requests/:sign_request_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sign_requests/:sign_request_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sign_requests/:sign_request_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sign_requests/:sign_request_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sign_requests/:sign_request_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sign_requests/:sign_request_id
http GET {{baseUrl}}/sign_requests/:sign_request_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sign_requests/:sign_request_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sign_requests/:sign_request_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List sign requests
{{baseUrl}}/sign_requests
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sign_requests");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sign_requests")
require "http/client"
url = "{{baseUrl}}/sign_requests"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sign_requests"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sign_requests");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sign_requests"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sign_requests HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sign_requests")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sign_requests"))
.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}}/sign_requests")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sign_requests")
.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}}/sign_requests');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sign_requests'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sign_requests';
const options = {method: 'GET'};
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}}/sign_requests',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sign_requests")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sign_requests',
headers: {}
};
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}}/sign_requests'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sign_requests');
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}}/sign_requests'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sign_requests';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sign_requests"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/sign_requests" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sign_requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sign_requests');
echo $response->getBody();
setUrl('{{baseUrl}}/sign_requests');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sign_requests');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sign_requests' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sign_requests' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sign_requests")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sign_requests"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sign_requests"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sign_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sign_requests') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sign_requests";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sign_requests
http GET {{baseUrl}}/sign_requests
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sign_requests
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sign_requests")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Resend sign request
{{baseUrl}}/sign_requests/:sign_request_id/resend
QUERY PARAMS
sign_request_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sign_requests/:sign_request_id/resend");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sign_requests/:sign_request_id/resend")
require "http/client"
url = "{{baseUrl}}/sign_requests/:sign_request_id/resend"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sign_requests/:sign_request_id/resend"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sign_requests/:sign_request_id/resend");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sign_requests/:sign_request_id/resend"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sign_requests/:sign_request_id/resend HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sign_requests/:sign_request_id/resend")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sign_requests/:sign_request_id/resend"))
.method("POST", 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}}/sign_requests/:sign_request_id/resend")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sign_requests/:sign_request_id/resend")
.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('POST', '{{baseUrl}}/sign_requests/:sign_request_id/resend');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sign_requests/:sign_request_id/resend'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sign_requests/:sign_request_id/resend';
const options = {method: 'POST'};
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}}/sign_requests/:sign_request_id/resend',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sign_requests/:sign_request_id/resend")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sign_requests/:sign_request_id/resend',
headers: {}
};
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: 'POST',
url: '{{baseUrl}}/sign_requests/:sign_request_id/resend'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sign_requests/:sign_request_id/resend');
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}}/sign_requests/:sign_request_id/resend'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sign_requests/:sign_request_id/resend';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sign_requests/:sign_request_id/resend"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
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}}/sign_requests/:sign_request_id/resend" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sign_requests/:sign_request_id/resend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sign_requests/:sign_request_id/resend');
echo $response->getBody();
setUrl('{{baseUrl}}/sign_requests/:sign_request_id/resend');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sign_requests/:sign_request_id/resend');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sign_requests/:sign_request_id/resend' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sign_requests/:sign_request_id/resend' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/sign_requests/:sign_request_id/resend")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sign_requests/:sign_request_id/resend"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sign_requests/:sign_request_id/resend"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sign_requests/:sign_request_id/resend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sign_requests/:sign_request_id/resend') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sign_requests/:sign_request_id/resend";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sign_requests/:sign_request_id/resend
http POST {{baseUrl}}/sign_requests/:sign_request_id/resend
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sign_requests/:sign_request_id/resend
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sign_requests/:sign_request_id/resend")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Add classification
{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add")
require "http/client"
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add"))
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add")
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add';
const options = {method: 'PUT'};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema',
headers: {}
};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add');
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add'
http PUT '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add'
wget --quiet \
--method PUT \
--output-document \
- '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"copyInstanceOnItemCopy": true,
"displayName": "Classification",
"hidden": false,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "securityClassification-6VMVochwUWo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Add initial classifications
{{baseUrl}}/metadata_templates/schema#classifications
BODY json
{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": "",
"staticConfig": {
"classification": {
"classificationDefinition": "",
"colorID": ""
}
}
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/schema#classifications");
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 \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata_templates/schema#classifications" {:content-type :json
:form-params {:copyInstanceOnItemCopy false
:displayName ""
:fields [{:displayName ""
:hidden false
:key ""
:options [{:key ""
:staticConfig {:classification {:classificationDefinition ""
:colorID ""}}}]
:type ""}]
:hidden false
:scope ""
:templateKey ""}})
require "http/client"
url = "{{baseUrl}}/metadata_templates/schema#classifications"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_templates/schema#classifications"),
Content = new StringContent("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_templates/schema#classifications");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/schema#classifications"
payload := strings.NewReader("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/metadata_templates/schema HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 455
{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": "",
"staticConfig": {
"classification": {
"classificationDefinition": "",
"colorID": ""
}
}
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata_templates/schema#classifications")
.setHeader("content-type", "application/json")
.setBody("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/schema#classifications"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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 \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata_templates/schema#classifications")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata_templates/schema#classifications")
.header("content-type", "application/json")
.body("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
.asString();
const data = JSON.stringify({
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
displayName: '',
hidden: false,
key: '',
options: [
{
key: '',
staticConfig: {
classification: {
classificationDefinition: '',
colorID: ''
}
}
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata_templates/schema#classifications');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_templates/schema#classifications',
headers: {'content-type': 'application/json'},
data: {
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
displayName: '',
hidden: false,
key: '',
options: [
{
key: '',
staticConfig: {classification: {classificationDefinition: '', colorID: ''}}
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/schema#classifications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"copyInstanceOnItemCopy":false,"displayName":"","fields":[{"displayName":"","hidden":false,"key":"","options":[{"key":"","staticConfig":{"classification":{"classificationDefinition":"","colorID":""}}}],"type":""}],"hidden":false,"scope":"","templateKey":""}'
};
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}}/metadata_templates/schema#classifications',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "copyInstanceOnItemCopy": false,\n "displayName": "",\n "fields": [\n {\n "displayName": "",\n "hidden": false,\n "key": "",\n "options": [\n {\n "key": "",\n "staticConfig": {\n "classification": {\n "classificationDefinition": "",\n "colorID": ""\n }\n }\n }\n ],\n "type": ""\n }\n ],\n "hidden": false,\n "scope": "",\n "templateKey": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/schema#classifications")
.post(body)
.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/metadata_templates/schema',
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({
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
displayName: '',
hidden: false,
key: '',
options: [
{
key: '',
staticConfig: {classification: {classificationDefinition: '', colorID: ''}}
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_templates/schema#classifications',
headers: {'content-type': 'application/json'},
body: {
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
displayName: '',
hidden: false,
key: '',
options: [
{
key: '',
staticConfig: {classification: {classificationDefinition: '', colorID: ''}}
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
},
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}}/metadata_templates/schema#classifications');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
displayName: '',
hidden: false,
key: '',
options: [
{
key: '',
staticConfig: {
classification: {
classificationDefinition: '',
colorID: ''
}
}
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
});
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}}/metadata_templates/schema#classifications',
headers: {'content-type': 'application/json'},
data: {
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
displayName: '',
hidden: false,
key: '',
options: [
{
key: '',
staticConfig: {classification: {classificationDefinition: '', colorID: ''}}
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/schema#classifications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"copyInstanceOnItemCopy":false,"displayName":"","fields":[{"displayName":"","hidden":false,"key":"","options":[{"key":"","staticConfig":{"classification":{"classificationDefinition":"","colorID":""}}}],"type":""}],"hidden":false,"scope":"","templateKey":""}'
};
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 = @{ @"copyInstanceOnItemCopy": @NO,
@"displayName": @"",
@"fields": @[ @{ @"displayName": @"", @"hidden": @NO, @"key": @"", @"options": @[ @{ @"key": @"", @"staticConfig": @{ @"classification": @{ @"classificationDefinition": @"", @"colorID": @"" } } } ], @"type": @"" } ],
@"hidden": @NO,
@"scope": @"",
@"templateKey": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/schema#classifications"]
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}}/metadata_templates/schema#classifications" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/schema#classifications",
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([
'copyInstanceOnItemCopy' => null,
'displayName' => '',
'fields' => [
[
'displayName' => '',
'hidden' => null,
'key' => '',
'options' => [
[
'key' => '',
'staticConfig' => [
'classification' => [
'classificationDefinition' => '',
'colorID' => ''
]
]
]
],
'type' => ''
]
],
'hidden' => null,
'scope' => '',
'templateKey' => ''
]),
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('POST', '{{baseUrl}}/metadata_templates/schema#classifications', [
'body' => '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": "",
"staticConfig": {
"classification": {
"classificationDefinition": "",
"colorID": ""
}
}
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/schema#classifications');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'copyInstanceOnItemCopy' => null,
'displayName' => '',
'fields' => [
[
'displayName' => '',
'hidden' => null,
'key' => '',
'options' => [
[
'key' => '',
'staticConfig' => [
'classification' => [
'classificationDefinition' => '',
'colorID' => ''
]
]
]
],
'type' => ''
]
],
'hidden' => null,
'scope' => '',
'templateKey' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'copyInstanceOnItemCopy' => null,
'displayName' => '',
'fields' => [
[
'displayName' => '',
'hidden' => null,
'key' => '',
'options' => [
[
'key' => '',
'staticConfig' => [
'classification' => [
'classificationDefinition' => '',
'colorID' => ''
]
]
]
],
'type' => ''
]
],
'hidden' => null,
'scope' => '',
'templateKey' => ''
]));
$request->setRequestUrl('{{baseUrl}}/metadata_templates/schema#classifications');
$request->setRequestMethod('POST');
$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}}/metadata_templates/schema#classifications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": "",
"staticConfig": {
"classification": {
"classificationDefinition": "",
"colorID": ""
}
}
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/schema#classifications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": "",
"staticConfig": {
"classification": {
"classificationDefinition": "",
"colorID": ""
}
}
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata_templates/schema", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/schema#classifications"
payload = {
"copyInstanceOnItemCopy": False,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": False,
"key": "",
"options": [
{
"key": "",
"staticConfig": { "classification": {
"classificationDefinition": "",
"colorID": ""
} }
}
],
"type": ""
}
],
"hidden": False,
"scope": "",
"templateKey": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/schema#classifications"
payload <- "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_templates/schema#classifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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/metadata_templates/schema') do |req|
req.body = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"\",\n \"colorID\": \"\"\n }\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/schema#classifications";
let payload = json!({
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": (
json!({
"displayName": "",
"hidden": false,
"key": "",
"options": (
json!({
"key": "",
"staticConfig": json!({"classification": json!({
"classificationDefinition": "",
"colorID": ""
})})
})
),
"type": ""
})
),
"hidden": false,
"scope": "",
"templateKey": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/metadata_templates/schema#classifications' \
--header 'content-type: application/json' \
--data '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": "",
"staticConfig": {
"classification": {
"classificationDefinition": "",
"colorID": ""
}
}
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}'
echo '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": "",
"staticConfig": {
"classification": {
"classificationDefinition": "",
"colorID": ""
}
}
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}' | \
http POST '{{baseUrl}}/metadata_templates/schema#classifications' \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "copyInstanceOnItemCopy": false,\n "displayName": "",\n "fields": [\n {\n "displayName": "",\n "hidden": false,\n "key": "",\n "options": [\n {\n "key": "",\n "staticConfig": {\n "classification": {\n "classificationDefinition": "",\n "colorID": ""\n }\n }\n }\n ],\n "type": ""\n }\n ],\n "hidden": false,\n "scope": "",\n "templateKey": ""\n}' \
--output-document \
- '{{baseUrl}}/metadata_templates/schema#classifications'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
[
"displayName": "",
"hidden": false,
"key": "",
"options": [
[
"key": "",
"staticConfig": ["classification": [
"classificationDefinition": "",
"colorID": ""
]]
]
],
"type": ""
]
],
"hidden": false,
"scope": "",
"templateKey": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/schema#classifications")! 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
{
"copyInstanceOnItemCopy": true,
"displayName": "Classification",
"hidden": false,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "securityClassification-6VMVochwUWo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete all classifications
{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
require "http/client"
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"))
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema';
const options = {method: 'DELETE'};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema',
headers: {}
};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
http DELETE {{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Delete classification
{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete")
require "http/client"
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete"))
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete")
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete';
const options = {method: 'PUT'};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema',
headers: {}
};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete');
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete'
http PUT '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete'
wget --quiet \
--method PUT \
--output-document \
- '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"copyInstanceOnItemCopy": true,
"displayName": "Classification",
"hidden": false,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "securityClassification-6VMVochwUWo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List all classifications
{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
require "http/client"
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"))
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema';
const options = {method: 'GET'};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema',
headers: {}
};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
http GET {{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"copyInstanceOnItemCopy": true,
"displayName": "Classification",
"hidden": false,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "securityClassification-6VMVochwUWo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update classification
{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update")
require "http/client"
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update"))
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update")
.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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update';
const options = {method: 'PUT'};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema',
headers: {}
};
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update');
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update'
http PUT '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update'
wget --quiet \
--method PUT \
--output-document \
- '{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"copyInstanceOnItemCopy": true,
"displayName": "Classification",
"hidden": false,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "securityClassification-6VMVochwUWo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Add classification to file
{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
file_id
BODY json
{
"Box__Security__Classification__Key": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
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 \"Box__Security__Classification__Key\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo" {:content-type :json
:form-params {:Box__Security__Classification__Key ""}})
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"Box__Security__Classification__Key\": \"\"\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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
Content = new StringContent("{\n \"Box__Security__Classification__Key\": \"\"\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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"Box__Security__Classification__Key\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
payload := strings.NewReader("{\n \"Box__Security__Classification__Key\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 46
{
"Box__Security__Classification__Key": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.setHeader("content-type", "application/json")
.setBody("{\n \"Box__Security__Classification__Key\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"Box__Security__Classification__Key\": \"\"\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 \"Box__Security__Classification__Key\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.header("content-type", "application/json")
.body("{\n \"Box__Security__Classification__Key\": \"\"\n}")
.asString();
const data = JSON.stringify({
Box__Security__Classification__Key: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {'content-type': 'application/json'},
data: {Box__Security__Classification__Key: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"Box__Security__Classification__Key":""}'
};
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "Box__Security__Classification__Key": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"Box__Security__Classification__Key\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.post(body)
.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/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
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({Box__Security__Classification__Key: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {'content-type': 'application/json'},
body: {Box__Security__Classification__Key: ''},
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
Box__Security__Classification__Key: ''
});
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {'content-type': 'application/json'},
data: {Box__Security__Classification__Key: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"Box__Security__Classification__Key":""}'
};
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 = @{ @"Box__Security__Classification__Key": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"Box__Security__Classification__Key\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo",
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([
'Box__Security__Classification__Key' => ''
]),
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('POST', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo', [
'body' => '{
"Box__Security__Classification__Key": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'Box__Security__Classification__Key' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'Box__Security__Classification__Key' => ''
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('POST');
$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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"Box__Security__Classification__Key": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"Box__Security__Classification__Key": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"Box__Security__Classification__Key\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
payload = { "Box__Security__Classification__Key": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
payload <- "{\n \"Box__Security__Classification__Key\": \"\"\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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"Box__Security__Classification__Key\": \"\"\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/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
req.body = "{\n \"Box__Security__Classification__Key\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let payload = json!({"Box__Security__Classification__Key": ""});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo \
--header 'content-type: application/json' \
--data '{
"Box__Security__Classification__Key": ""
}'
echo '{
"Box__Security__Classification__Key": ""
}' | \
http POST {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "Box__Security__Classification__Key": ""\n}' \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["Box__Security__Classification__Key": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")! 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
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get classification on file
{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'GET'};
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {}
};
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
http GET {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove classification from file
{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'DELETE'};
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {}
};
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
http DELETE {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update classification on file
{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'PUT'};
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {}
};
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
http PUT {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Add classification to folder
{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
folder_id
BODY json
{
"Box__Security__Classification__Key": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
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 \"Box__Security__Classification__Key\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo" {:content-type :json
:form-params {:Box__Security__Classification__Key ""}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"Box__Security__Classification__Key\": \"\"\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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
Content = new StringContent("{\n \"Box__Security__Classification__Key\": \"\"\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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"Box__Security__Classification__Key\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
payload := strings.NewReader("{\n \"Box__Security__Classification__Key\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 46
{
"Box__Security__Classification__Key": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.setHeader("content-type", "application/json")
.setBody("{\n \"Box__Security__Classification__Key\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"Box__Security__Classification__Key\": \"\"\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 \"Box__Security__Classification__Key\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.header("content-type", "application/json")
.body("{\n \"Box__Security__Classification__Key\": \"\"\n}")
.asString();
const data = JSON.stringify({
Box__Security__Classification__Key: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {'content-type': 'application/json'},
data: {Box__Security__Classification__Key: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"Box__Security__Classification__Key":""}'
};
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "Box__Security__Classification__Key": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"Box__Security__Classification__Key\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.post(body)
.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/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
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({Box__Security__Classification__Key: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {'content-type': 'application/json'},
body: {Box__Security__Classification__Key: ''},
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
Box__Security__Classification__Key: ''
});
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {'content-type': 'application/json'},
data: {Box__Security__Classification__Key: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"Box__Security__Classification__Key":""}'
};
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 = @{ @"Box__Security__Classification__Key": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"Box__Security__Classification__Key\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo",
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([
'Box__Security__Classification__Key' => ''
]),
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('POST', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo', [
'body' => '{
"Box__Security__Classification__Key": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'Box__Security__Classification__Key' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'Box__Security__Classification__Key' => ''
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('POST');
$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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"Box__Security__Classification__Key": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"Box__Security__Classification__Key": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"Box__Security__Classification__Key\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
payload = { "Box__Security__Classification__Key": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
payload <- "{\n \"Box__Security__Classification__Key\": \"\"\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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"Box__Security__Classification__Key\": \"\"\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/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
req.body = "{\n \"Box__Security__Classification__Key\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let payload = json!({"Box__Security__Classification__Key": ""});
let mut headers = reqwest::header::HeaderMap::new();
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo \
--header 'content-type: application/json' \
--data '{
"Box__Security__Classification__Key": ""
}'
echo '{
"Box__Security__Classification__Key": ""
}' | \
http POST {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "Box__Security__Classification__Key": ""\n}' \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["Box__Security__Classification__Key": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")! 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
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get classification on folder
{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'GET'};
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {}
};
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
http GET {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove classification from folder
{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'DELETE'};
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {}
};
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
http DELETE {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update classification on folder
{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"))
.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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'PUT'};
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo',
headers: {}
};
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
http PUT {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create collaboration
{{baseUrl}}/collaborations
BODY json
{
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": false,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaborations");
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 \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/collaborations" {:content-type :json
:form-params {:accessible_by {:id ""
:login ""
:type ""}
:can_view_path false
:expires_at ""
:item {:id ""
:type ""}
:role ""}})
require "http/client"
url = "{{baseUrl}}/collaborations"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\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}}/collaborations"),
Content = new StringContent("{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\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}}/collaborations");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaborations"
payload := strings.NewReader("{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/collaborations HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 180
{
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": false,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/collaborations")
.setHeader("content-type", "application/json")
.setBody("{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaborations"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\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 \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/collaborations")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/collaborations")
.header("content-type", "application/json")
.body("{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}")
.asString();
const data = JSON.stringify({
accessible_by: {
id: '',
login: '',
type: ''
},
can_view_path: false,
expires_at: '',
item: {
id: '',
type: ''
},
role: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/collaborations');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/collaborations',
headers: {'content-type': 'application/json'},
data: {
accessible_by: {id: '', login: '', type: ''},
can_view_path: false,
expires_at: '',
item: {id: '', type: ''},
role: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaborations';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accessible_by":{"id":"","login":"","type":""},"can_view_path":false,"expires_at":"","item":{"id":"","type":""},"role":""}'
};
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}}/collaborations',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "accessible_by": {\n "id": "",\n "login": "",\n "type": ""\n },\n "can_view_path": false,\n "expires_at": "",\n "item": {\n "id": "",\n "type": ""\n },\n "role": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/collaborations")
.post(body)
.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/collaborations',
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({
accessible_by: {id: '', login: '', type: ''},
can_view_path: false,
expires_at: '',
item: {id: '', type: ''},
role: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/collaborations',
headers: {'content-type': 'application/json'},
body: {
accessible_by: {id: '', login: '', type: ''},
can_view_path: false,
expires_at: '',
item: {id: '', type: ''},
role: ''
},
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}}/collaborations');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
accessible_by: {
id: '',
login: '',
type: ''
},
can_view_path: false,
expires_at: '',
item: {
id: '',
type: ''
},
role: ''
});
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}}/collaborations',
headers: {'content-type': 'application/json'},
data: {
accessible_by: {id: '', login: '', type: ''},
can_view_path: false,
expires_at: '',
item: {id: '', type: ''},
role: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaborations';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accessible_by":{"id":"","login":"","type":""},"can_view_path":false,"expires_at":"","item":{"id":"","type":""},"role":""}'
};
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 = @{ @"accessible_by": @{ @"id": @"", @"login": @"", @"type": @"" },
@"can_view_path": @NO,
@"expires_at": @"",
@"item": @{ @"id": @"", @"type": @"" },
@"role": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaborations"]
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}}/collaborations" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaborations",
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([
'accessible_by' => [
'id' => '',
'login' => '',
'type' => ''
],
'can_view_path' => null,
'expires_at' => '',
'item' => [
'id' => '',
'type' => ''
],
'role' => ''
]),
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('POST', '{{baseUrl}}/collaborations', [
'body' => '{
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": false,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/collaborations');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'accessible_by' => [
'id' => '',
'login' => '',
'type' => ''
],
'can_view_path' => null,
'expires_at' => '',
'item' => [
'id' => '',
'type' => ''
],
'role' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'accessible_by' => [
'id' => '',
'login' => '',
'type' => ''
],
'can_view_path' => null,
'expires_at' => '',
'item' => [
'id' => '',
'type' => ''
],
'role' => ''
]));
$request->setRequestUrl('{{baseUrl}}/collaborations');
$request->setRequestMethod('POST');
$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}}/collaborations' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": false,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaborations' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": false,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/collaborations", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaborations"
payload = {
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": False,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaborations"
payload <- "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\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}}/collaborations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\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/collaborations') do |req|
req.body = "{\n \"accessible_by\": {\n \"id\": \"\",\n \"login\": \"\",\n \"type\": \"\"\n },\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"role\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaborations";
let payload = json!({
"accessible_by": json!({
"id": "",
"login": "",
"type": ""
}),
"can_view_path": false,
"expires_at": "",
"item": json!({
"id": "",
"type": ""
}),
"role": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/collaborations \
--header 'content-type: application/json' \
--data '{
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": false,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}'
echo '{
"accessible_by": {
"id": "",
"login": "",
"type": ""
},
"can_view_path": false,
"expires_at": "",
"item": {
"id": "",
"type": ""
},
"role": ""
}' | \
http POST {{baseUrl}}/collaborations \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "accessible_by": {\n "id": "",\n "login": "",\n "type": ""\n },\n "can_view_path": false,\n "expires_at": "",\n "item": {\n "id": "",\n "type": ""\n },\n "role": ""\n}' \
--output-document \
- {{baseUrl}}/collaborations
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"accessible_by": [
"id": "",
"login": "",
"type": ""
],
"can_view_path": false,
"expires_at": "",
"item": [
"id": "",
"type": ""
],
"role": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaborations")! 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
{
"acknowledged_at": "2012-12-12T10:55:20-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"expires_at": "2012-12-26T10:53:43-08:00",
"id": "12345678",
"invite_email": "john@example.com",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "editor",
"status": "accepted",
"type": "collaboration"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get collaboration
{{baseUrl}}/collaborations/:collaboration_id
QUERY PARAMS
collaboration_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaborations/:collaboration_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collaborations/:collaboration_id")
require "http/client"
url = "{{baseUrl}}/collaborations/:collaboration_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collaborations/:collaboration_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaborations/:collaboration_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaborations/:collaboration_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collaborations/:collaboration_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collaborations/:collaboration_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaborations/:collaboration_id"))
.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}}/collaborations/:collaboration_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collaborations/:collaboration_id")
.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}}/collaborations/:collaboration_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/collaborations/:collaboration_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaborations/:collaboration_id';
const options = {method: 'GET'};
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}}/collaborations/:collaboration_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaborations/:collaboration_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaborations/:collaboration_id',
headers: {}
};
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}}/collaborations/:collaboration_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collaborations/:collaboration_id');
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}}/collaborations/:collaboration_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaborations/:collaboration_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaborations/:collaboration_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collaborations/:collaboration_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaborations/:collaboration_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collaborations/:collaboration_id');
echo $response->getBody();
setUrl('{{baseUrl}}/collaborations/:collaboration_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaborations/:collaboration_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaborations/:collaboration_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaborations/:collaboration_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collaborations/:collaboration_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaborations/:collaboration_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaborations/:collaboration_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaborations/:collaboration_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collaborations/:collaboration_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaborations/:collaboration_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/collaborations/:collaboration_id
http GET {{baseUrl}}/collaborations/:collaboration_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/collaborations/:collaboration_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaborations/:collaboration_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"acknowledged_at": "2012-12-12T10:55:20-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"expires_at": "2012-12-26T10:53:43-08:00",
"id": "12345678",
"invite_email": "john@example.com",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "editor",
"status": "accepted",
"type": "collaboration"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove collaboration
{{baseUrl}}/collaborations/:collaboration_id
QUERY PARAMS
collaboration_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaborations/:collaboration_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/collaborations/:collaboration_id")
require "http/client"
url = "{{baseUrl}}/collaborations/:collaboration_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/collaborations/:collaboration_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaborations/:collaboration_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaborations/:collaboration_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/collaborations/:collaboration_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/collaborations/:collaboration_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaborations/:collaboration_id"))
.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}}/collaborations/:collaboration_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/collaborations/:collaboration_id")
.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}}/collaborations/:collaboration_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/collaborations/:collaboration_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaborations/:collaboration_id';
const options = {method: 'DELETE'};
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}}/collaborations/:collaboration_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaborations/:collaboration_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaborations/:collaboration_id',
headers: {}
};
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}}/collaborations/:collaboration_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/collaborations/:collaboration_id');
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}}/collaborations/:collaboration_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaborations/:collaboration_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaborations/:collaboration_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/collaborations/:collaboration_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaborations/:collaboration_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/collaborations/:collaboration_id');
echo $response->getBody();
setUrl('{{baseUrl}}/collaborations/:collaboration_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaborations/:collaboration_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaborations/:collaboration_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaborations/:collaboration_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/collaborations/:collaboration_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaborations/:collaboration_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaborations/:collaboration_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaborations/:collaboration_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/collaborations/:collaboration_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaborations/:collaboration_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/collaborations/:collaboration_id
http DELETE {{baseUrl}}/collaborations/:collaboration_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/collaborations/:collaboration_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaborations/:collaboration_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update collaboration
{{baseUrl}}/collaborations/:collaboration_id
QUERY PARAMS
collaboration_id
BODY json
{
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaborations/:collaboration_id");
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 \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/collaborations/:collaboration_id" {:content-type :json
:form-params {:can_view_path false
:expires_at ""
:role ""
:status ""}})
require "http/client"
url = "{{baseUrl}}/collaborations/:collaboration_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\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}}/collaborations/:collaboration_id"),
Content = new StringContent("{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\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}}/collaborations/:collaboration_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaborations/:collaboration_id"
payload := strings.NewReader("{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\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/collaborations/:collaboration_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 78
{
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/collaborations/:collaboration_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaborations/:collaboration_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\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 \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/collaborations/:collaboration_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/collaborations/:collaboration_id")
.header("content-type", "application/json")
.body("{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}")
.asString();
const data = JSON.stringify({
can_view_path: false,
expires_at: '',
role: '',
status: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/collaborations/:collaboration_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/collaborations/:collaboration_id',
headers: {'content-type': 'application/json'},
data: {can_view_path: false, expires_at: '', role: '', status: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaborations/:collaboration_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"can_view_path":false,"expires_at":"","role":"","status":""}'
};
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}}/collaborations/:collaboration_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "can_view_path": false,\n "expires_at": "",\n "role": "",\n "status": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/collaborations/:collaboration_id")
.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/collaborations/:collaboration_id',
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({can_view_path: false, expires_at: '', role: '', status: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/collaborations/:collaboration_id',
headers: {'content-type': 'application/json'},
body: {can_view_path: false, expires_at: '', role: '', status: ''},
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}}/collaborations/:collaboration_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
can_view_path: false,
expires_at: '',
role: '',
status: ''
});
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}}/collaborations/:collaboration_id',
headers: {'content-type': 'application/json'},
data: {can_view_path: false, expires_at: '', role: '', status: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaborations/:collaboration_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"can_view_path":false,"expires_at":"","role":"","status":""}'
};
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 = @{ @"can_view_path": @NO,
@"expires_at": @"",
@"role": @"",
@"status": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaborations/:collaboration_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}}/collaborations/:collaboration_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaborations/:collaboration_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([
'can_view_path' => null,
'expires_at' => '',
'role' => '',
'status' => ''
]),
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}}/collaborations/:collaboration_id', [
'body' => '{
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/collaborations/:collaboration_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'can_view_path' => null,
'expires_at' => '',
'role' => '',
'status' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'can_view_path' => null,
'expires_at' => '',
'role' => '',
'status' => ''
]));
$request->setRequestUrl('{{baseUrl}}/collaborations/:collaboration_id');
$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}}/collaborations/:collaboration_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaborations/:collaboration_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/collaborations/:collaboration_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaborations/:collaboration_id"
payload = {
"can_view_path": False,
"expires_at": "",
"role": "",
"status": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaborations/:collaboration_id"
payload <- "{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\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}}/collaborations/:collaboration_id")
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 \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\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/collaborations/:collaboration_id') do |req|
req.body = "{\n \"can_view_path\": false,\n \"expires_at\": \"\",\n \"role\": \"\",\n \"status\": \"\"\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}}/collaborations/:collaboration_id";
let payload = json!({
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
});
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}}/collaborations/:collaboration_id \
--header 'content-type: application/json' \
--data '{
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
}'
echo '{
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
}' | \
http PUT {{baseUrl}}/collaborations/:collaboration_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "can_view_path": false,\n "expires_at": "",\n "role": "",\n "status": ""\n}' \
--output-document \
- {{baseUrl}}/collaborations/:collaboration_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"can_view_path": false,
"expires_at": "",
"role": "",
"status": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaborations/:collaboration_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
{
"acknowledged_at": "2012-12-12T10:55:20-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"expires_at": "2012-12-26T10:53:43-08:00",
"id": "12345678",
"invite_email": "john@example.com",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "editor",
"status": "accepted",
"type": "collaboration"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"acknowledged_at": "2012-12-12T10:55:20-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"expires_at": "2012-12-26T10:53:43-08:00",
"id": "12345678",
"invite_email": "john@example.com",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "editor",
"status": "accepted",
"type": "collaboration"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List file collaborations
{{baseUrl}}/files/:file_id/collaborations
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/collaborations");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/collaborations")
require "http/client"
url = "{{baseUrl}}/files/:file_id/collaborations"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/collaborations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/collaborations");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/collaborations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/collaborations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/collaborations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/collaborations"))
.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}}/files/:file_id/collaborations")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/collaborations")
.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}}/files/:file_id/collaborations');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id/collaborations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/collaborations';
const options = {method: 'GET'};
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}}/files/:file_id/collaborations',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/collaborations")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/collaborations',
headers: {}
};
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}}/files/:file_id/collaborations'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/collaborations');
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}}/files/:file_id/collaborations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/collaborations';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/collaborations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/collaborations" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/collaborations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/collaborations');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/collaborations');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/collaborations');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/collaborations' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/collaborations' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/collaborations")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/collaborations"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/collaborations"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/collaborations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/collaborations') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/collaborations";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/collaborations
http GET {{baseUrl}}/files/:file_id/collaborations
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/collaborations
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/collaborations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List folder collaborations
{{baseUrl}}/folders/:folder_id/collaborations
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/collaborations");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id/collaborations")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/collaborations"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/collaborations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/collaborations");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/collaborations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id/collaborations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id/collaborations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/collaborations"))
.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}}/folders/:folder_id/collaborations")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id/collaborations")
.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}}/folders/:folder_id/collaborations');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/folders/:folder_id/collaborations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/collaborations';
const options = {method: 'GET'};
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}}/folders/:folder_id/collaborations',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/collaborations")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/collaborations',
headers: {}
};
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}}/folders/:folder_id/collaborations'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id/collaborations');
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}}/folders/:folder_id/collaborations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/collaborations';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/collaborations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id/collaborations" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/collaborations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id/collaborations');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/collaborations');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/collaborations');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/collaborations' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/collaborations' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id/collaborations")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/collaborations"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/collaborations"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/collaborations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id/collaborations') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/collaborations";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id/collaborations
http GET {{baseUrl}}/folders/:folder_id/collaborations
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id/collaborations
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/collaborations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List group collaborations
{{baseUrl}}/groups/:group_id/collaborations
QUERY PARAMS
group_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups/:group_id/collaborations");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/groups/:group_id/collaborations")
require "http/client"
url = "{{baseUrl}}/groups/:group_id/collaborations"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/groups/:group_id/collaborations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/groups/:group_id/collaborations");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups/:group_id/collaborations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/groups/:group_id/collaborations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/groups/:group_id/collaborations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups/:group_id/collaborations"))
.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}}/groups/:group_id/collaborations")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/groups/:group_id/collaborations")
.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}}/groups/:group_id/collaborations');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/groups/:group_id/collaborations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups/:group_id/collaborations';
const options = {method: 'GET'};
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}}/groups/:group_id/collaborations',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/groups/:group_id/collaborations")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/groups/:group_id/collaborations',
headers: {}
};
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}}/groups/:group_id/collaborations'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/groups/:group_id/collaborations');
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}}/groups/:group_id/collaborations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups/:group_id/collaborations';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups/:group_id/collaborations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/groups/:group_id/collaborations" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups/:group_id/collaborations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/groups/:group_id/collaborations');
echo $response->getBody();
setUrl('{{baseUrl}}/groups/:group_id/collaborations');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/groups/:group_id/collaborations');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/groups/:group_id/collaborations' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups/:group_id/collaborations' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/groups/:group_id/collaborations")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups/:group_id/collaborations"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups/:group_id/collaborations"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/groups/:group_id/collaborations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/groups/:group_id/collaborations') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/groups/:group_id/collaborations";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/groups/:group_id/collaborations
http GET {{baseUrl}}/groups/:group_id/collaborations
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/groups/:group_id/collaborations
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups/:group_id/collaborations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List pending collaborations
{{baseUrl}}/collaborations
QUERY PARAMS
status
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaborations?status=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collaborations" {:query-params {:status ""}})
require "http/client"
url = "{{baseUrl}}/collaborations?status="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collaborations?status="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaborations?status=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaborations?status="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collaborations?status= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collaborations?status=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaborations?status="))
.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}}/collaborations?status=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collaborations?status=")
.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}}/collaborations?status=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/collaborations',
params: {status: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaborations?status=';
const options = {method: 'GET'};
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}}/collaborations?status=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaborations?status=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaborations?status=',
headers: {}
};
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}}/collaborations',
qs: {status: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collaborations');
req.query({
status: ''
});
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}}/collaborations',
params: {status: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaborations?status=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaborations?status="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collaborations?status=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaborations?status=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collaborations?status=');
echo $response->getBody();
setUrl('{{baseUrl}}/collaborations');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'status' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaborations');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'status' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaborations?status=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaborations?status=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collaborations?status=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaborations"
querystring = {"status":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaborations"
queryString <- list(status = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaborations?status=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collaborations') do |req|
req.params['status'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaborations";
let querystring = [
("status", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/collaborations?status='
http GET '{{baseUrl}}/collaborations?status='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/collaborations?status='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaborations?status=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List all collections
{{baseUrl}}/collections
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collections");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collections")
require "http/client"
url = "{{baseUrl}}/collections"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collections"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collections");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collections"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collections HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collections")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collections"))
.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}}/collections")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collections")
.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}}/collections');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/collections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collections';
const options = {method: 'GET'};
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}}/collections',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collections")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collections',
headers: {}
};
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}}/collections'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collections');
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}}/collections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collections" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collections');
echo $response->getBody();
setUrl('{{baseUrl}}/collections');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collections');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collections' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collections' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collections")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collections"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collections"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collections') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collections";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/collections
http GET {{baseUrl}}/collections
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/collections
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List collection items
{{baseUrl}}/collections/:collection_id/items
QUERY PARAMS
collection_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collections/:collection_id/items");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collections/:collection_id/items")
require "http/client"
url = "{{baseUrl}}/collections/:collection_id/items"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collections/:collection_id/items"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collections/:collection_id/items");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collections/:collection_id/items"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collections/:collection_id/items HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collections/:collection_id/items")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collections/:collection_id/items"))
.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}}/collections/:collection_id/items")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collections/:collection_id/items")
.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}}/collections/:collection_id/items');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/collections/:collection_id/items'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collections/:collection_id/items';
const options = {method: 'GET'};
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}}/collections/:collection_id/items',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collections/:collection_id/items")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collections/:collection_id/items',
headers: {}
};
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}}/collections/:collection_id/items'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collections/:collection_id/items');
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}}/collections/:collection_id/items'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collections/:collection_id/items';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collections/:collection_id/items"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collections/:collection_id/items" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collections/:collection_id/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collections/:collection_id/items');
echo $response->getBody();
setUrl('{{baseUrl}}/collections/:collection_id/items');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collections/:collection_id/items');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collections/:collection_id/items' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collections/:collection_id/items' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collections/:collection_id/items")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collections/:collection_id/items"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collections/:collection_id/items"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collections/:collection_id/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collections/:collection_id/items') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collections/:collection_id/items";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/collections/:collection_id/items
http GET {{baseUrl}}/collections/:collection_id/items
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/collections/:collection_id/items
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collections/:collection_id/items")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create comment
{{baseUrl}}/comments
BODY json
{
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments");
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 \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/comments" {:content-type :json
:form-params {:item {:id ""
:type ""}
:message ""
:tagged_message ""}})
require "http/client"
url = "{{baseUrl}}/comments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\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}}/comments"),
Content = new StringContent("{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\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}}/comments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments"
payload := strings.NewReader("{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/comments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 89
{
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/comments")
.setHeader("content-type", "application/json")
.setBody("{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\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 \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/comments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/comments")
.header("content-type", "application/json")
.body("{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}")
.asString();
const data = JSON.stringify({
item: {
id: '',
type: ''
},
message: '',
tagged_message: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/comments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/comments',
headers: {'content-type': 'application/json'},
data: {item: {id: '', type: ''}, message: '', tagged_message: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"item":{"id":"","type":""},"message":"","tagged_message":""}'
};
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}}/comments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "item": {\n "id": "",\n "type": ""\n },\n "message": "",\n "tagged_message": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/comments")
.post(body)
.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/comments',
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({item: {id: '', type: ''}, message: '', tagged_message: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/comments',
headers: {'content-type': 'application/json'},
body: {item: {id: '', type: ''}, message: '', tagged_message: ''},
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}}/comments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
item: {
id: '',
type: ''
},
message: '',
tagged_message: ''
});
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}}/comments',
headers: {'content-type': 'application/json'},
data: {item: {id: '', type: ''}, message: '', tagged_message: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"item":{"id":"","type":""},"message":"","tagged_message":""}'
};
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 = @{ @"item": @{ @"id": @"", @"type": @"" },
@"message": @"",
@"tagged_message": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments"]
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}}/comments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments",
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([
'item' => [
'id' => '',
'type' => ''
],
'message' => '',
'tagged_message' => ''
]),
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('POST', '{{baseUrl}}/comments', [
'body' => '{
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/comments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'item' => [
'id' => '',
'type' => ''
],
'message' => '',
'tagged_message' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'item' => [
'id' => '',
'type' => ''
],
'message' => '',
'tagged_message' => ''
]));
$request->setRequestUrl('{{baseUrl}}/comments');
$request->setRequestMethod('POST');
$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}}/comments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/comments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments"
payload = {
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments"
payload <- "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\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}}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\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/comments') do |req|
req.body = "{\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\",\n \"tagged_message\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/comments";
let payload = json!({
"item": json!({
"id": "",
"type": ""
}),
"message": "",
"tagged_message": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/comments \
--header 'content-type: application/json' \
--data '{
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}'
echo '{
"item": {
"id": "",
"type": ""
},
"message": "",
"tagged_message": ""
}' | \
http POST {{baseUrl}}/comments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "item": {\n "id": "",\n "type": ""\n },\n "message": "",\n "tagged_message": ""\n}' \
--output-document \
- {{baseUrl}}/comments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"item": [
"id": "",
"type": ""
],
"message": "",
"tagged_message": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get comment
{{baseUrl}}/comments/:comment_id
QUERY PARAMS
comment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments/:comment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/comments/:comment_id")
require "http/client"
url = "{{baseUrl}}/comments/:comment_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/comments/:comment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/comments/:comment_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments/:comment_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/comments/:comment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/comments/:comment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments/:comment_id"))
.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}}/comments/:comment_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/comments/:comment_id")
.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}}/comments/:comment_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/comments/:comment_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments/:comment_id';
const options = {method: 'GET'};
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}}/comments/:comment_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/comments/:comment_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/comments/:comment_id',
headers: {}
};
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}}/comments/:comment_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/comments/:comment_id');
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}}/comments/:comment_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments/:comment_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments/:comment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/comments/:comment_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments/:comment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/comments/:comment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/comments/:comment_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/comments/:comment_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/comments/:comment_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments/:comment_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/comments/:comment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments/:comment_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments/:comment_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/comments/:comment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/comments/:comment_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/comments/:comment_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/comments/:comment_id
http GET {{baseUrl}}/comments/:comment_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/comments/:comment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments/:comment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List file comments
{{baseUrl}}/files/:file_id/comments
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/comments");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/comments")
require "http/client"
url = "{{baseUrl}}/files/:file_id/comments"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/comments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/comments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/comments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/comments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/comments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/comments"))
.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}}/files/:file_id/comments")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/comments")
.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}}/files/:file_id/comments');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/files/:file_id/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/comments';
const options = {method: 'GET'};
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}}/files/:file_id/comments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/comments")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/comments',
headers: {}
};
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}}/files/:file_id/comments'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/comments');
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}}/files/:file_id/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/comments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/comments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/comments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/comments');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/comments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/comments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/comments' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/comments' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/comments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/comments"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/comments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/comments') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/comments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/comments
http GET {{baseUrl}}/files/:file_id/comments
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/comments
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/comments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove comment
{{baseUrl}}/comments/:comment_id
QUERY PARAMS
comment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments/:comment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/comments/:comment_id")
require "http/client"
url = "{{baseUrl}}/comments/:comment_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/comments/:comment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/comments/:comment_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments/:comment_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/comments/:comment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/comments/:comment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments/:comment_id"))
.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}}/comments/:comment_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/comments/:comment_id")
.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}}/comments/:comment_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/comments/:comment_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments/:comment_id';
const options = {method: 'DELETE'};
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}}/comments/:comment_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/comments/:comment_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/comments/:comment_id',
headers: {}
};
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}}/comments/:comment_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/comments/:comment_id');
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}}/comments/:comment_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments/:comment_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments/:comment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/comments/:comment_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments/:comment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/comments/:comment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/comments/:comment_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/comments/:comment_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/comments/:comment_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments/:comment_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/comments/:comment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments/:comment_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments/:comment_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/comments/:comment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/comments/:comment_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/comments/:comment_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/comments/:comment_id
http DELETE {{baseUrl}}/comments/:comment_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/comments/:comment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments/:comment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update comment
{{baseUrl}}/comments/:comment_id
QUERY PARAMS
comment_id
BODY json
{
"message": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments/:comment_id");
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 \"message\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/comments/:comment_id" {:content-type :json
:form-params {:message ""}})
require "http/client"
url = "{{baseUrl}}/comments/:comment_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"message\": \"\"\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}}/comments/:comment_id"),
Content = new StringContent("{\n \"message\": \"\"\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}}/comments/:comment_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"message\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments/:comment_id"
payload := strings.NewReader("{\n \"message\": \"\"\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/comments/:comment_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 19
{
"message": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/comments/:comment_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"message\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments/:comment_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"message\": \"\"\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 \"message\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/comments/:comment_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/comments/:comment_id")
.header("content-type", "application/json")
.body("{\n \"message\": \"\"\n}")
.asString();
const data = JSON.stringify({
message: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/comments/:comment_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/comments/:comment_id',
headers: {'content-type': 'application/json'},
data: {message: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments/:comment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"message":""}'
};
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}}/comments/:comment_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "message": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"message\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/comments/:comment_id")
.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/comments/:comment_id',
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({message: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/comments/:comment_id',
headers: {'content-type': 'application/json'},
body: {message: ''},
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}}/comments/:comment_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
message: ''
});
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}}/comments/:comment_id',
headers: {'content-type': 'application/json'},
data: {message: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments/:comment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"message":""}'
};
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 = @{ @"message": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments/:comment_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}}/comments/:comment_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"message\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments/:comment_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([
'message' => ''
]),
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}}/comments/:comment_id', [
'body' => '{
"message": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/comments/:comment_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'message' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'message' => ''
]));
$request->setRequestUrl('{{baseUrl}}/comments/:comment_id');
$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}}/comments/:comment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"message": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments/:comment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"message": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"message\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/comments/:comment_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments/:comment_id"
payload = { "message": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments/:comment_id"
payload <- "{\n \"message\": \"\"\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}}/comments/:comment_id")
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 \"message\": \"\"\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/comments/:comment_id') do |req|
req.body = "{\n \"message\": \"\"\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}}/comments/:comment_id";
let payload = json!({"message": ""});
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}}/comments/:comment_id \
--header 'content-type: application/json' \
--data '{
"message": ""
}'
echo '{
"message": ""
}' | \
http PUT {{baseUrl}}/comments/:comment_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "message": ""\n}' \
--output-document \
- {{baseUrl}}/comments/:comment_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["message": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments/:comment_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get device pin
{{baseUrl}}/device_pinners/:device_pinner_id
QUERY PARAMS
device_pinner_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/device_pinners/:device_pinner_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/device_pinners/:device_pinner_id")
require "http/client"
url = "{{baseUrl}}/device_pinners/:device_pinner_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/device_pinners/:device_pinner_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/device_pinners/:device_pinner_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/device_pinners/:device_pinner_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/device_pinners/:device_pinner_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/device_pinners/:device_pinner_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/device_pinners/:device_pinner_id"))
.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}}/device_pinners/:device_pinner_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/device_pinners/:device_pinner_id")
.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}}/device_pinners/:device_pinner_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/device_pinners/:device_pinner_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/device_pinners/:device_pinner_id';
const options = {method: 'GET'};
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}}/device_pinners/:device_pinner_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/device_pinners/:device_pinner_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/device_pinners/:device_pinner_id',
headers: {}
};
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}}/device_pinners/:device_pinner_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/device_pinners/:device_pinner_id');
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}}/device_pinners/:device_pinner_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/device_pinners/:device_pinner_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/device_pinners/:device_pinner_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/device_pinners/:device_pinner_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/device_pinners/:device_pinner_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/device_pinners/:device_pinner_id');
echo $response->getBody();
setUrl('{{baseUrl}}/device_pinners/:device_pinner_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/device_pinners/:device_pinner_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/device_pinners/:device_pinner_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/device_pinners/:device_pinner_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/device_pinners/:device_pinner_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/device_pinners/:device_pinner_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/device_pinners/:device_pinner_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/device_pinners/:device_pinner_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/device_pinners/:device_pinner_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/device_pinners/:device_pinner_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/device_pinners/:device_pinner_id
http GET {{baseUrl}}/device_pinners/:device_pinner_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/device_pinners/:device_pinner_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/device_pinners/:device_pinner_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"id": "11446498",
"product_name": "iPad",
"type": "device_pinner"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List enterprise device pins
{{baseUrl}}/enterprises/:enterprise_id/device_pinners
QUERY PARAMS
enterprise_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/enterprises/:enterprise_id/device_pinners");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/enterprises/:enterprise_id/device_pinners")
require "http/client"
url = "{{baseUrl}}/enterprises/:enterprise_id/device_pinners"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/enterprises/:enterprise_id/device_pinners"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/enterprises/:enterprise_id/device_pinners");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/enterprises/:enterprise_id/device_pinners"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/enterprises/:enterprise_id/device_pinners HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/enterprises/:enterprise_id/device_pinners")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/enterprises/:enterprise_id/device_pinners"))
.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}}/enterprises/:enterprise_id/device_pinners")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/enterprises/:enterprise_id/device_pinners")
.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}}/enterprises/:enterprise_id/device_pinners');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/enterprises/:enterprise_id/device_pinners'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/enterprises/:enterprise_id/device_pinners';
const options = {method: 'GET'};
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}}/enterprises/:enterprise_id/device_pinners',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/enterprises/:enterprise_id/device_pinners")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/enterprises/:enterprise_id/device_pinners',
headers: {}
};
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}}/enterprises/:enterprise_id/device_pinners'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/enterprises/:enterprise_id/device_pinners');
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}}/enterprises/:enterprise_id/device_pinners'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/enterprises/:enterprise_id/device_pinners';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/enterprises/:enterprise_id/device_pinners"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/enterprises/:enterprise_id/device_pinners" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/enterprises/:enterprise_id/device_pinners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/enterprises/:enterprise_id/device_pinners');
echo $response->getBody();
setUrl('{{baseUrl}}/enterprises/:enterprise_id/device_pinners');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/enterprises/:enterprise_id/device_pinners');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/enterprises/:enterprise_id/device_pinners' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/enterprises/:enterprise_id/device_pinners' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/enterprises/:enterprise_id/device_pinners")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/enterprises/:enterprise_id/device_pinners"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/enterprises/:enterprise_id/device_pinners"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/enterprises/:enterprise_id/device_pinners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/enterprises/:enterprise_id/device_pinners') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/enterprises/:enterprise_id/device_pinners";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/enterprises/:enterprise_id/device_pinners
http GET {{baseUrl}}/enterprises/:enterprise_id/device_pinners
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/enterprises/:enterprise_id/device_pinners
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/enterprises/:enterprise_id/device_pinners")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 200,
"next_marker": 3000
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove device pin
{{baseUrl}}/device_pinners/:device_pinner_id
QUERY PARAMS
device_pinner_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/device_pinners/:device_pinner_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/device_pinners/:device_pinner_id")
require "http/client"
url = "{{baseUrl}}/device_pinners/:device_pinner_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/device_pinners/:device_pinner_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/device_pinners/:device_pinner_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/device_pinners/:device_pinner_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/device_pinners/:device_pinner_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/device_pinners/:device_pinner_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/device_pinners/:device_pinner_id"))
.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}}/device_pinners/:device_pinner_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/device_pinners/:device_pinner_id")
.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}}/device_pinners/:device_pinner_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/device_pinners/:device_pinner_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/device_pinners/:device_pinner_id';
const options = {method: 'DELETE'};
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}}/device_pinners/:device_pinner_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/device_pinners/:device_pinner_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/device_pinners/:device_pinner_id',
headers: {}
};
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}}/device_pinners/:device_pinner_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/device_pinners/:device_pinner_id');
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}}/device_pinners/:device_pinner_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/device_pinners/:device_pinner_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/device_pinners/:device_pinner_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/device_pinners/:device_pinner_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/device_pinners/:device_pinner_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/device_pinners/:device_pinner_id');
echo $response->getBody();
setUrl('{{baseUrl}}/device_pinners/:device_pinner_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/device_pinners/:device_pinner_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/device_pinners/:device_pinner_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/device_pinners/:device_pinner_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/device_pinners/:device_pinner_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/device_pinners/:device_pinner_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/device_pinners/:device_pinner_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/device_pinners/:device_pinner_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/device_pinners/:device_pinner_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/device_pinners/:device_pinner_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/device_pinners/:device_pinner_id
http DELETE {{baseUrl}}/device_pinners/:device_pinner_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/device_pinners/:device_pinner_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/device_pinners/:device_pinner_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create user exemption from collaboration domain restrictions
{{baseUrl}}/collaboration_whitelist_exempt_targets
BODY json
{
"user": {
"id": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_exempt_targets");
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 \"user\": {\n \"id\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/collaboration_whitelist_exempt_targets" {:content-type :json
:form-params {:user {:id ""}}})
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"user\": {\n \"id\": \"\"\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}}/collaboration_whitelist_exempt_targets"),
Content = new StringContent("{\n \"user\": {\n \"id\": \"\"\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}}/collaboration_whitelist_exempt_targets");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"user\": {\n \"id\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_exempt_targets"
payload := strings.NewReader("{\n \"user\": {\n \"id\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/collaboration_whitelist_exempt_targets HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 32
{
"user": {
"id": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/collaboration_whitelist_exempt_targets")
.setHeader("content-type", "application/json")
.setBody("{\n \"user\": {\n \"id\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_exempt_targets"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"user\": {\n \"id\": \"\"\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 \"user\": {\n \"id\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_exempt_targets")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/collaboration_whitelist_exempt_targets")
.header("content-type", "application/json")
.body("{\n \"user\": {\n \"id\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
user: {
id: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/collaboration_whitelist_exempt_targets');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/collaboration_whitelist_exempt_targets',
headers: {'content-type': 'application/json'},
data: {user: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"user":{"id":""}}'
};
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}}/collaboration_whitelist_exempt_targets',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "user": {\n "id": ""\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 \"user\": {\n \"id\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_exempt_targets")
.post(body)
.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/collaboration_whitelist_exempt_targets',
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({user: {id: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/collaboration_whitelist_exempt_targets',
headers: {'content-type': 'application/json'},
body: {user: {id: ''}},
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}}/collaboration_whitelist_exempt_targets');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
user: {
id: ''
}
});
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}}/collaboration_whitelist_exempt_targets',
headers: {'content-type': 'application/json'},
data: {user: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"user":{"id":""}}'
};
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 = @{ @"user": @{ @"id": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_exempt_targets"]
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}}/collaboration_whitelist_exempt_targets" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"user\": {\n \"id\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_exempt_targets",
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([
'user' => [
'id' => ''
]
]),
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('POST', '{{baseUrl}}/collaboration_whitelist_exempt_targets', [
'body' => '{
"user": {
"id": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'user' => [
'id' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'user' => [
'id' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets');
$request->setRequestMethod('POST');
$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}}/collaboration_whitelist_exempt_targets' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"user": {
"id": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_exempt_targets' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"user": {
"id": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"user\": {\n \"id\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/collaboration_whitelist_exempt_targets", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets"
payload = { "user": { "id": "" } }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_exempt_targets"
payload <- "{\n \"user\": {\n \"id\": \"\"\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}}/collaboration_whitelist_exempt_targets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"user\": {\n \"id\": \"\"\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/collaboration_whitelist_exempt_targets') do |req|
req.body = "{\n \"user\": {\n \"id\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_exempt_targets";
let payload = json!({"user": json!({"id": ""})});
let mut headers = reqwest::header::HeaderMap::new();
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}}/collaboration_whitelist_exempt_targets \
--header 'content-type: application/json' \
--data '{
"user": {
"id": ""
}
}'
echo '{
"user": {
"id": ""
}
}' | \
http POST {{baseUrl}}/collaboration_whitelist_exempt_targets \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "user": {\n "id": ""\n }\n}' \
--output-document \
- {{baseUrl}}/collaboration_whitelist_exempt_targets
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["user": ["id": ""]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_exempt_targets")! 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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"modified_at": "2012-12-12T10:53:43-08:00",
"type": "collaboration_whitelist"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get user exempt from collaboration domain restrictions
{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
QUERY PARAMS
collaboration_whitelist_exempt_target_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"))
.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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id';
const options = {method: 'GET'};
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id',
headers: {}
};
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
http GET {{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"modified_at": "2012-12-12T10:53:43-08:00",
"type": "collaboration_whitelist"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List users exempt from collaboration domain restrictions
{{baseUrl}}/collaboration_whitelist_exempt_targets
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_exempt_targets");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collaboration_whitelist_exempt_targets")
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collaboration_whitelist_exempt_targets"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaboration_whitelist_exempt_targets");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_exempt_targets"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collaboration_whitelist_exempt_targets HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collaboration_whitelist_exempt_targets")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_exempt_targets"))
.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}}/collaboration_whitelist_exempt_targets")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collaboration_whitelist_exempt_targets")
.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}}/collaboration_whitelist_exempt_targets');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/collaboration_whitelist_exempt_targets'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets';
const options = {method: 'GET'};
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}}/collaboration_whitelist_exempt_targets',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_exempt_targets")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaboration_whitelist_exempt_targets',
headers: {}
};
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}}/collaboration_whitelist_exempt_targets'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collaboration_whitelist_exempt_targets');
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}}/collaboration_whitelist_exempt_targets'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_exempt_targets"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collaboration_whitelist_exempt_targets" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_exempt_targets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collaboration_whitelist_exempt_targets');
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaboration_whitelist_exempt_targets' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_exempt_targets' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collaboration_whitelist_exempt_targets")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_exempt_targets"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaboration_whitelist_exempt_targets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collaboration_whitelist_exempt_targets') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_exempt_targets";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/collaboration_whitelist_exempt_targets
http GET {{baseUrl}}/collaboration_whitelist_exempt_targets
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/collaboration_whitelist_exempt_targets
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_exempt_targets")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove user from list of users exempt from domain restrictions
{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
QUERY PARAMS
collaboration_whitelist_exempt_target_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"))
.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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id';
const options = {method: 'DELETE'};
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id',
headers: {}
};
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
http DELETE {{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Add domain to list of allowed collaboration domains
{{baseUrl}}/collaboration_whitelist_entries
BODY json
{
"direction": "",
"domain": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_entries");
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 \"direction\": \"\",\n \"domain\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/collaboration_whitelist_entries" {:content-type :json
:form-params {:direction ""
:domain ""}})
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_entries"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"direction\": \"\",\n \"domain\": \"\"\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}}/collaboration_whitelist_entries"),
Content = new StringContent("{\n \"direction\": \"\",\n \"domain\": \"\"\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}}/collaboration_whitelist_entries");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"direction\": \"\",\n \"domain\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_entries"
payload := strings.NewReader("{\n \"direction\": \"\",\n \"domain\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/collaboration_whitelist_entries HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 37
{
"direction": "",
"domain": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/collaboration_whitelist_entries")
.setHeader("content-type", "application/json")
.setBody("{\n \"direction\": \"\",\n \"domain\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_entries"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"direction\": \"\",\n \"domain\": \"\"\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 \"direction\": \"\",\n \"domain\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_entries")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/collaboration_whitelist_entries")
.header("content-type", "application/json")
.body("{\n \"direction\": \"\",\n \"domain\": \"\"\n}")
.asString();
const data = JSON.stringify({
direction: '',
domain: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/collaboration_whitelist_entries');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/collaboration_whitelist_entries',
headers: {'content-type': 'application/json'},
data: {direction: '', domain: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_entries';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"direction":"","domain":""}'
};
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}}/collaboration_whitelist_entries',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "direction": "",\n "domain": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"direction\": \"\",\n \"domain\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_entries")
.post(body)
.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/collaboration_whitelist_entries',
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({direction: '', domain: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/collaboration_whitelist_entries',
headers: {'content-type': 'application/json'},
body: {direction: '', domain: ''},
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}}/collaboration_whitelist_entries');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
direction: '',
domain: ''
});
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}}/collaboration_whitelist_entries',
headers: {'content-type': 'application/json'},
data: {direction: '', domain: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_entries';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"direction":"","domain":""}'
};
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 = @{ @"direction": @"",
@"domain": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_entries"]
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}}/collaboration_whitelist_entries" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"direction\": \"\",\n \"domain\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_entries",
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([
'direction' => '',
'domain' => ''
]),
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('POST', '{{baseUrl}}/collaboration_whitelist_entries', [
'body' => '{
"direction": "",
"domain": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_entries');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'direction' => '',
'domain' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'direction' => '',
'domain' => ''
]));
$request->setRequestUrl('{{baseUrl}}/collaboration_whitelist_entries');
$request->setRequestMethod('POST');
$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}}/collaboration_whitelist_entries' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"direction": "",
"domain": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_entries' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"direction": "",
"domain": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"direction\": \"\",\n \"domain\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/collaboration_whitelist_entries", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_entries"
payload = {
"direction": "",
"domain": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_entries"
payload <- "{\n \"direction\": \"\",\n \"domain\": \"\"\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}}/collaboration_whitelist_entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"direction\": \"\",\n \"domain\": \"\"\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/collaboration_whitelist_entries') do |req|
req.body = "{\n \"direction\": \"\",\n \"domain\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_entries";
let payload = json!({
"direction": "",
"domain": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/collaboration_whitelist_entries \
--header 'content-type: application/json' \
--data '{
"direction": "",
"domain": ""
}'
echo '{
"direction": "",
"domain": ""
}' | \
http POST {{baseUrl}}/collaboration_whitelist_entries \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "direction": "",\n "domain": ""\n}' \
--output-document \
- {{baseUrl}}/collaboration_whitelist_entries
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"direction": "",
"domain": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_entries")! 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
{
"created_at": "2012-12-12T10:53:43-08:00",
"direction": "both",
"domain": "example.com",
"id": "11446498",
"type": "collaboration_whitelist_entry"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get allowed collaboration domain
{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
QUERY PARAMS
collaboration_whitelist_entry_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"))
.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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id';
const options = {method: 'GET'};
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id',
headers: {}
};
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
http GET {{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2012-12-12T10:53:43-08:00",
"direction": "both",
"domain": "example.com",
"id": "11446498",
"type": "collaboration_whitelist_entry"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List allowed collaboration domains
{{baseUrl}}/collaboration_whitelist_entries
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_entries");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/collaboration_whitelist_entries")
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_entries"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/collaboration_whitelist_entries"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaboration_whitelist_entries");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_entries"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/collaboration_whitelist_entries HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/collaboration_whitelist_entries")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_entries"))
.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}}/collaboration_whitelist_entries")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/collaboration_whitelist_entries")
.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}}/collaboration_whitelist_entries');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/collaboration_whitelist_entries'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_entries';
const options = {method: 'GET'};
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}}/collaboration_whitelist_entries',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_entries")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaboration_whitelist_entries',
headers: {}
};
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}}/collaboration_whitelist_entries'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/collaboration_whitelist_entries');
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}}/collaboration_whitelist_entries'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_entries';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_entries"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/collaboration_whitelist_entries" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/collaboration_whitelist_entries');
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_entries');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaboration_whitelist_entries');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaboration_whitelist_entries' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_entries' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/collaboration_whitelist_entries")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_entries"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_entries"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaboration_whitelist_entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/collaboration_whitelist_entries') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_entries";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/collaboration_whitelist_entries
http GET {{baseUrl}}/collaboration_whitelist_entries
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/collaboration_whitelist_entries
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_entries")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove domain from list of allowed collaboration domains
{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
QUERY PARAMS
collaboration_whitelist_entry_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
require "http/client"
url = "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"))
.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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id';
const options = {method: 'DELETE'};
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id',
headers: {}
};
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
echo $response->getBody();
setUrl('{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/collaboration_whitelist_entries/:collaboration_whitelist_entry_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
http DELETE {{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/collaboration_whitelist_entries/:collaboration_whitelist_entry_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Download file
{{baseUrl}}/files/:file_id/content
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/content");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/content")
require "http/client"
url = "{{baseUrl}}/files/:file_id/content"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/content"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/content");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/content"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/content HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/content")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/content"))
.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}}/files/:file_id/content")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/content")
.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}}/files/:file_id/content');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/files/:file_id/content'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/content';
const options = {method: 'GET'};
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}}/files/:file_id/content',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/content")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/content',
headers: {}
};
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}}/files/:file_id/content'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/content');
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}}/files/:file_id/content'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/content';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/content"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/content" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/content",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/content');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/content');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/content');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/content' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/content' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/content")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/content"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/content"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/content")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/content') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/content";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/content
http GET {{baseUrl}}/files/:file_id/content
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/content
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/content")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create email alias
{{baseUrl}}/users/:user_id/email_aliases
QUERY PARAMS
user_id
BODY json
{
"email": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/email_aliases");
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 \"email\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/:user_id/email_aliases" {:content-type :json
:form-params {:email ""}})
require "http/client"
url = "{{baseUrl}}/users/:user_id/email_aliases"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\"\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}}/users/:user_id/email_aliases"),
Content = new StringContent("{\n \"email\": \"\"\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}}/users/:user_id/email_aliases");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/email_aliases"
payload := strings.NewReader("{\n \"email\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/users/:user_id/email_aliases HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"email": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/:user_id/email_aliases")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/email_aliases"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\"\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 \"email\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:user_id/email_aliases")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/users/:user_id/email_aliases")
.header("content-type", "application/json")
.body("{\n \"email\": \"\"\n}")
.asString();
const data = JSON.stringify({
email: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/:user_id/email_aliases');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:user_id/email_aliases',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/email_aliases';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
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}}/users/:user_id/email_aliases',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/email_aliases")
.post(body)
.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/users/:user_id/email_aliases',
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({email: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:user_id/email_aliases',
headers: {'content-type': 'application/json'},
body: {email: ''},
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}}/users/:user_id/email_aliases');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: ''
});
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}}/users/:user_id/email_aliases',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id/email_aliases';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
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 = @{ @"email": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/email_aliases"]
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}}/users/:user_id/email_aliases" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/email_aliases",
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([
'email' => ''
]),
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('POST', '{{baseUrl}}/users/:user_id/email_aliases', [
'body' => '{
"email": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/email_aliases');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'email' => ''
]));
$request->setRequestUrl('{{baseUrl}}/users/:user_id/email_aliases');
$request->setRequestMethod('POST');
$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}}/users/:user_id/email_aliases' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/email_aliases' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users/:user_id/email_aliases", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/email_aliases"
payload = { "email": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/email_aliases"
payload <- "{\n \"email\": \"\"\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}}/users/:user_id/email_aliases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"email\": \"\"\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/users/:user_id/email_aliases') do |req|
req.body = "{\n \"email\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id/email_aliases";
let payload = json!({"email": ""});
let mut headers = reqwest::header::HeaderMap::new();
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}}/users/:user_id/email_aliases \
--header 'content-type: application/json' \
--data '{
"email": ""
}'
echo '{
"email": ""
}' | \
http POST {{baseUrl}}/users/:user_id/email_aliases \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "email": ""\n}' \
--output-document \
- {{baseUrl}}/users/:user_id/email_aliases
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["email": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/email_aliases")! 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
{
"email": "alias@example.com",
"id": "11446498",
"is_confirmed": true,
"type": "email_alias"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List user's email aliases
{{baseUrl}}/users/:user_id/email_aliases
QUERY PARAMS
user_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/email_aliases");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:user_id/email_aliases")
require "http/client"
url = "{{baseUrl}}/users/:user_id/email_aliases"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:user_id/email_aliases"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id/email_aliases");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/email_aliases"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/:user_id/email_aliases HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:user_id/email_aliases")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/email_aliases"))
.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}}/users/:user_id/email_aliases")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/:user_id/email_aliases")
.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}}/users/:user_id/email_aliases');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:user_id/email_aliases'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/email_aliases';
const options = {method: 'GET'};
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}}/users/:user_id/email_aliases',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/email_aliases")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id/email_aliases',
headers: {}
};
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}}/users/:user_id/email_aliases'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:user_id/email_aliases');
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}}/users/:user_id/email_aliases'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id/email_aliases';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/email_aliases"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/:user_id/email_aliases" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/email_aliases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/users/:user_id/email_aliases');
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/email_aliases');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/:user_id/email_aliases');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id/email_aliases' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/email_aliases' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:user_id/email_aliases")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/email_aliases"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/email_aliases"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id/email_aliases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:user_id/email_aliases') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id/email_aliases";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:user_id/email_aliases
http GET {{baseUrl}}/users/:user_id/email_aliases
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:user_id/email_aliases
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/email_aliases")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"total_count": 5000
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove email alias
{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id
QUERY PARAMS
user_id
email_alias_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id")
require "http/client"
url = "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/users/:user_id/email_aliases/:email_alias_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id"))
.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}}/users/:user_id/email_aliases/:email_alias_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id")
.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}}/users/:user_id/email_aliases/:email_alias_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id';
const options = {method: 'DELETE'};
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}}/users/:user_id/email_aliases/:email_alias_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id/email_aliases/:email_alias_id',
headers: {}
};
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}}/users/:user_id/email_aliases/:email_alias_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id');
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}}/users/:user_id/email_aliases/:email_alias_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/users/:user_id/email_aliases/:email_alias_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id');
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/users/:user_id/email_aliases/:email_alias_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/users/:user_id/email_aliases/:email_alias_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/users/:user_id/email_aliases/:email_alias_id
http DELETE {{baseUrl}}/users/:user_id/email_aliases/:email_alias_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/users/:user_id/email_aliases/:email_alias_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
OPTIONS
Get events long poll endpoint
{{baseUrl}}/events
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "OPTIONS");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/options "{{baseUrl}}/events")
require "http/client"
url = "{{baseUrl}}/events"
response = HTTP::Client.options url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Options,
RequestUri = new Uri("{{baseUrl}}/events"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events");
var request = new RestRequest("", Method.Options);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events"
req, _ := http.NewRequest("OPTIONS", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
OPTIONS /baseUrl/events HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("OPTIONS", "{{baseUrl}}/events")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events"))
.method("OPTIONS", 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}}/events")
.method("OPTIONS", null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.options("{{baseUrl}}/events")
.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('OPTIONS', '{{baseUrl}}/events');
xhr.send(data);
import axios from 'axios';
const options = {method: 'OPTIONS', url: '{{baseUrl}}/events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events';
const options = {method: 'OPTIONS'};
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}}/events',
method: 'OPTIONS',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events")
.method("OPTIONS", null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'OPTIONS',
hostname: 'example.com',
port: null,
path: '/baseUrl/events',
headers: {}
};
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: 'OPTIONS', url: '{{baseUrl}}/events'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('OPTIONS', '{{baseUrl}}/events');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'OPTIONS', url: '{{baseUrl}}/events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events';
const options = {method: 'OPTIONS'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/events"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"OPTIONS"];
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}}/events" in
Client.call `OPTIONS uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "OPTIONS",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('OPTIONS', '{{baseUrl}}/events');
echo $response->getBody();
setUrl('{{baseUrl}}/events');
$request->setMethod(HTTP_METH_OPTIONS);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events');
$request->setRequestMethod('OPTIONS');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events' -Method OPTIONS
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events' -Method OPTIONS
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("OPTIONS", "/baseUrl/events")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events"
response = requests.options(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events"
response <- VERB("OPTIONS", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Options.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.options('/baseUrl/events') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("OPTIONS").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request OPTIONS \
--url {{baseUrl}}/events
http OPTIONS {{baseUrl}}/events
wget --quiet \
--method OPTIONS \
--output-document \
- {{baseUrl}}/events
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "OPTIONS"
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
{
"chunk_size": 1
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List user and enterprise events
{{baseUrl}}/events
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/events")
require "http/client"
url = "{{baseUrl}}/events"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/events"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/events HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/events")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events"))
.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}}/events")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/events")
.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}}/events');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events';
const options = {method: 'GET'};
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}}/events',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/events',
headers: {}
};
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}}/events'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/events');
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}}/events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/events"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/events" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/events');
echo $response->getBody();
setUrl('{{baseUrl}}/events');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/events")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/events') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/events
http GET {{baseUrl}}/events
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/events
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"chunk_size": 2,
"next_stream_position": "1152922976252290886"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Copy file request
{{baseUrl}}/file_requests/:file_request_id/copy
QUERY PARAMS
file_request_id
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_requests/:file_request_id/copy");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/file_requests/:file_request_id/copy" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/file_requests/:file_request_id/copy"
headers = HTTP::Headers{
"content-type" => "application/json"
}
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}}/file_requests/:file_request_id/copy"),
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}}/file_requests/:file_request_id/copy");
var request = new RestRequest("", Method.Post);
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}}/file_requests/:file_request_id/copy"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/file_requests/:file_request_id/copy HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/file_requests/:file_request_id/copy")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_requests/:file_request_id/copy"))
.header("content-type", "application/json")
.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}}/file_requests/:file_request_id/copy")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/file_requests/:file_request_id/copy")
.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('POST', '{{baseUrl}}/file_requests/:file_request_id/copy');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/file_requests/:file_request_id/copy',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_requests/:file_request_id/copy';
const options = {method: 'POST', headers: {'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}}/file_requests/:file_request_id/copy',
method: 'POST',
headers: {
'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}}/file_requests/:file_request_id/copy")
.post(body)
.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/file_requests/:file_request_id/copy',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/file_requests/:file_request_id/copy',
headers: {'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('POST', '{{baseUrl}}/file_requests/:file_request_id/copy');
req.headers({
'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: 'POST',
url: '{{baseUrl}}/file_requests/:file_request_id/copy',
headers: {'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}}/file_requests/:file_request_id/copy';
const options = {method: 'POST', headers: {'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 = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_requests/:file_request_id/copy"]
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}}/file_requests/:file_request_id/copy" in
let headers = Header.add (Header.init ()) "content-type" "application/json" 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}}/file_requests/:file_request_id/copy",
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 => [
"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}}/file_requests/:file_request_id/copy', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/file_requests/:file_request_id/copy');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'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}}/file_requests/:file_request_id/copy');
$request->setRequestMethod('POST');
$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}}/file_requests/:file_request_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_requests/:file_request_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/file_requests/:file_request_id/copy", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_requests/:file_request_id/copy"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_requests/:file_request_id/copy"
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}}/file_requests/:file_request_id/copy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
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/file_requests/:file_request_id/copy') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/file_requests/:file_request_id/copy";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
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}}/file_requests/:file_request_id/copy \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/file_requests/:file_request_id/copy \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/file_requests/:file_request_id/copy
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_requests/:file_request_id/copy")! 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
{
"created_at": "2020-09-28T10:53:43-08:00",
"description": "Following documents are requested for your process",
"etag": "1",
"expires_at": "2020-09-28T10:53:43-08:00",
"id": "42037322",
"is_description_required": true,
"is_email_required": true,
"status": "active",
"title": "Please upload documents",
"type": "file_request",
"updated_at": "2020-09-28T10:53:43-08:00",
"url": "/f/19e57f40ace247278a8e3d336678c64a"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete file request
{{baseUrl}}/file_requests/:file_request_id
QUERY PARAMS
file_request_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_requests/:file_request_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/file_requests/:file_request_id")
require "http/client"
url = "{{baseUrl}}/file_requests/:file_request_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/file_requests/:file_request_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/file_requests/:file_request_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/file_requests/:file_request_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/file_requests/:file_request_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/file_requests/:file_request_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_requests/:file_request_id"))
.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}}/file_requests/:file_request_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/file_requests/:file_request_id")
.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}}/file_requests/:file_request_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/file_requests/:file_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_requests/:file_request_id';
const options = {method: 'DELETE'};
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}}/file_requests/:file_request_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/file_requests/:file_request_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/file_requests/:file_request_id',
headers: {}
};
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}}/file_requests/:file_request_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/file_requests/:file_request_id');
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}}/file_requests/:file_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/file_requests/:file_request_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_requests/:file_request_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/file_requests/:file_request_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/file_requests/:file_request_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/file_requests/:file_request_id');
echo $response->getBody();
setUrl('{{baseUrl}}/file_requests/:file_request_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/file_requests/:file_request_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/file_requests/:file_request_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_requests/:file_request_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/file_requests/:file_request_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_requests/:file_request_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_requests/:file_request_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/file_requests/:file_request_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/file_requests/:file_request_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/file_requests/:file_request_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/file_requests/:file_request_id
http DELETE {{baseUrl}}/file_requests/:file_request_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/file_requests/:file_request_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_requests/:file_request_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get file request
{{baseUrl}}/file_requests/:file_request_id
QUERY PARAMS
file_request_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_requests/:file_request_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/file_requests/:file_request_id")
require "http/client"
url = "{{baseUrl}}/file_requests/:file_request_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/file_requests/:file_request_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/file_requests/:file_request_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/file_requests/:file_request_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/file_requests/:file_request_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/file_requests/:file_request_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_requests/:file_request_id"))
.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}}/file_requests/:file_request_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/file_requests/:file_request_id")
.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}}/file_requests/:file_request_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/file_requests/:file_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_requests/:file_request_id';
const options = {method: 'GET'};
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}}/file_requests/:file_request_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/file_requests/:file_request_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/file_requests/:file_request_id',
headers: {}
};
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}}/file_requests/:file_request_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/file_requests/:file_request_id');
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}}/file_requests/:file_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/file_requests/:file_request_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_requests/:file_request_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/file_requests/:file_request_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/file_requests/:file_request_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/file_requests/:file_request_id');
echo $response->getBody();
setUrl('{{baseUrl}}/file_requests/:file_request_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/file_requests/:file_request_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/file_requests/:file_request_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_requests/:file_request_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/file_requests/:file_request_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_requests/:file_request_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_requests/:file_request_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/file_requests/:file_request_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/file_requests/:file_request_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/file_requests/:file_request_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/file_requests/:file_request_id
http GET {{baseUrl}}/file_requests/:file_request_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/file_requests/:file_request_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_requests/:file_request_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2020-09-28T10:53:43-08:00",
"description": "Following documents are requested for your process",
"etag": "1",
"expires_at": "2020-09-28T10:53:43-08:00",
"id": "42037322",
"is_description_required": true,
"is_email_required": true,
"status": "active",
"title": "Please upload documents",
"type": "file_request",
"updated_at": "2020-09-28T10:53:43-08:00",
"url": "/f/19e57f40ace247278a8e3d336678c64a"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update file request
{{baseUrl}}/file_requests/:file_request_id
QUERY PARAMS
file_request_id
BODY json
{
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_requests/:file_request_id");
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 \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/file_requests/:file_request_id" {:content-type :json
:form-params {:description ""
:expires_at ""
:is_description_required false
:is_email_required false
:status ""
:title ""}})
require "http/client"
url = "{{baseUrl}}/file_requests/:file_request_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\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}}/file_requests/:file_request_id"),
Content = new StringContent("{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\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}}/file_requests/:file_request_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/file_requests/:file_request_id"
payload := strings.NewReader("{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\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/file_requests/:file_request_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 140
{
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/file_requests/:file_request_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_requests/:file_request_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\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 \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/file_requests/:file_request_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/file_requests/:file_request_id")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
expires_at: '',
is_description_required: false,
is_email_required: false,
status: '',
title: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/file_requests/:file_request_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/file_requests/:file_request_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
expires_at: '',
is_description_required: false,
is_email_required: false,
status: '',
title: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_requests/:file_request_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","expires_at":"","is_description_required":false,"is_email_required":false,"status":"","title":""}'
};
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}}/file_requests/:file_request_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "expires_at": "",\n "is_description_required": false,\n "is_email_required": false,\n "status": "",\n "title": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/file_requests/:file_request_id")
.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/file_requests/:file_request_id',
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({
description: '',
expires_at: '',
is_description_required: false,
is_email_required: false,
status: '',
title: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/file_requests/:file_request_id',
headers: {'content-type': 'application/json'},
body: {
description: '',
expires_at: '',
is_description_required: false,
is_email_required: false,
status: '',
title: ''
},
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}}/file_requests/:file_request_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
expires_at: '',
is_description_required: false,
is_email_required: false,
status: '',
title: ''
});
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}}/file_requests/:file_request_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
expires_at: '',
is_description_required: false,
is_email_required: false,
status: '',
title: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/file_requests/:file_request_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","expires_at":"","is_description_required":false,"is_email_required":false,"status":"","title":""}'
};
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 = @{ @"description": @"",
@"expires_at": @"",
@"is_description_required": @NO,
@"is_email_required": @NO,
@"status": @"",
@"title": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_requests/:file_request_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}}/file_requests/:file_request_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/file_requests/:file_request_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([
'description' => '',
'expires_at' => '',
'is_description_required' => null,
'is_email_required' => null,
'status' => '',
'title' => ''
]),
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}}/file_requests/:file_request_id', [
'body' => '{
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/file_requests/:file_request_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'expires_at' => '',
'is_description_required' => null,
'is_email_required' => null,
'status' => '',
'title' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'expires_at' => '',
'is_description_required' => null,
'is_email_required' => null,
'status' => '',
'title' => ''
]));
$request->setRequestUrl('{{baseUrl}}/file_requests/:file_request_id');
$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}}/file_requests/:file_request_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_requests/:file_request_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/file_requests/:file_request_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_requests/:file_request_id"
payload = {
"description": "",
"expires_at": "",
"is_description_required": False,
"is_email_required": False,
"status": "",
"title": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_requests/:file_request_id"
payload <- "{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\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}}/file_requests/:file_request_id")
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 \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\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/file_requests/:file_request_id') do |req|
req.body = "{\n \"description\": \"\",\n \"expires_at\": \"\",\n \"is_description_required\": false,\n \"is_email_required\": false,\n \"status\": \"\",\n \"title\": \"\"\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}}/file_requests/:file_request_id";
let payload = json!({
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
});
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}}/file_requests/:file_request_id \
--header 'content-type: application/json' \
--data '{
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
}'
echo '{
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
}' | \
http PUT {{baseUrl}}/file_requests/:file_request_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "expires_at": "",\n "is_description_required": false,\n "is_email_required": false,\n "status": "",\n "title": ""\n}' \
--output-document \
- {{baseUrl}}/file_requests/:file_request_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"expires_at": "",
"is_description_required": false,
"is_email_required": false,
"status": "",
"title": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_requests/:file_request_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
{
"created_at": "2020-09-28T10:53:43-08:00",
"description": "Following documents are requested for your process",
"etag": "1",
"expires_at": "2020-09-28T10:53:43-08:00",
"id": "42037322",
"is_description_required": true,
"is_email_required": true,
"status": "active",
"title": "Please upload documents",
"type": "file_request",
"updated_at": "2020-09-28T10:53:43-08:00",
"url": "/f/19e57f40ace247278a8e3d336678c64a"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get file version legal hold
{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id
QUERY PARAMS
file_version_legal_hold_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id")
require "http/client"
url = "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/file_version_legal_holds/:file_version_legal_hold_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id"))
.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}}/file_version_legal_holds/:file_version_legal_hold_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id")
.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}}/file_version_legal_holds/:file_version_legal_hold_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id';
const options = {method: 'GET'};
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}}/file_version_legal_holds/:file_version_legal_hold_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/file_version_legal_holds/:file_version_legal_hold_id',
headers: {}
};
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}}/file_version_legal_holds/:file_version_legal_hold_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id');
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}}/file_version_legal_holds/:file_version_legal_hold_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/file_version_legal_holds/:file_version_legal_hold_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id');
echo $response->getBody();
setUrl('{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/file_version_legal_holds/:file_version_legal_hold_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/file_version_legal_holds/:file_version_legal_hold_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id
http GET {{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_version_legal_holds/:file_version_legal_hold_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"deleted_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"type": "file_version_legal_hold"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List file version legal holds
{{baseUrl}}/file_version_legal_holds
QUERY PARAMS
policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_version_legal_holds?policy_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/file_version_legal_holds" {:query-params {:policy_id ""}})
require "http/client"
url = "{{baseUrl}}/file_version_legal_holds?policy_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/file_version_legal_holds?policy_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/file_version_legal_holds?policy_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/file_version_legal_holds?policy_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/file_version_legal_holds?policy_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/file_version_legal_holds?policy_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_version_legal_holds?policy_id="))
.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}}/file_version_legal_holds?policy_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/file_version_legal_holds?policy_id=")
.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}}/file_version_legal_holds?policy_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/file_version_legal_holds',
params: {policy_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_version_legal_holds?policy_id=';
const options = {method: 'GET'};
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}}/file_version_legal_holds?policy_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/file_version_legal_holds?policy_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/file_version_legal_holds?policy_id=',
headers: {}
};
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}}/file_version_legal_holds',
qs: {policy_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/file_version_legal_holds');
req.query({
policy_id: ''
});
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}}/file_version_legal_holds',
params: {policy_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/file_version_legal_holds?policy_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_version_legal_holds?policy_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/file_version_legal_holds?policy_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/file_version_legal_holds?policy_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/file_version_legal_holds?policy_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/file_version_legal_holds');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'policy_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/file_version_legal_holds');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'policy_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/file_version_legal_holds?policy_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_version_legal_holds?policy_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/file_version_legal_holds?policy_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_version_legal_holds"
querystring = {"policy_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_version_legal_holds"
queryString <- list(policy_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/file_version_legal_holds?policy_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/file_version_legal_holds') do |req|
req.params['policy_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/file_version_legal_holds";
let querystring = [
("policy_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/file_version_legal_holds?policy_id='
http GET '{{baseUrl}}/file_version_legal_holds?policy_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/file_version_legal_holds?policy_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_version_legal_holds?policy_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get retention on file
{{baseUrl}}/file_version_retentions/:file_version_retention_id
QUERY PARAMS
file_version_retention_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_version_retentions/:file_version_retention_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/file_version_retentions/:file_version_retention_id")
require "http/client"
url = "{{baseUrl}}/file_version_retentions/:file_version_retention_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/file_version_retentions/:file_version_retention_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/file_version_retentions/:file_version_retention_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/file_version_retentions/:file_version_retention_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/file_version_retentions/:file_version_retention_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/file_version_retentions/:file_version_retention_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_version_retentions/:file_version_retention_id"))
.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}}/file_version_retentions/:file_version_retention_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/file_version_retentions/:file_version_retention_id")
.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}}/file_version_retentions/:file_version_retention_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/file_version_retentions/:file_version_retention_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_version_retentions/:file_version_retention_id';
const options = {method: 'GET'};
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}}/file_version_retentions/:file_version_retention_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/file_version_retentions/:file_version_retention_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/file_version_retentions/:file_version_retention_id',
headers: {}
};
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}}/file_version_retentions/:file_version_retention_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/file_version_retentions/:file_version_retention_id');
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}}/file_version_retentions/:file_version_retention_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/file_version_retentions/:file_version_retention_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_version_retentions/:file_version_retention_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/file_version_retentions/:file_version_retention_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/file_version_retentions/:file_version_retention_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/file_version_retentions/:file_version_retention_id');
echo $response->getBody();
setUrl('{{baseUrl}}/file_version_retentions/:file_version_retention_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/file_version_retentions/:file_version_retention_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/file_version_retentions/:file_version_retention_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_version_retentions/:file_version_retention_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/file_version_retentions/:file_version_retention_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_version_retentions/:file_version_retention_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_version_retentions/:file_version_retention_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/file_version_retentions/:file_version_retention_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/file_version_retentions/:file_version_retention_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/file_version_retentions/:file_version_retention_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/file_version_retentions/:file_version_retention_id
http GET {{baseUrl}}/file_version_retentions/:file_version_retention_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/file_version_retentions/:file_version_retention_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_version_retentions/:file_version_retention_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"applied_at": "2012-12-12T10:53:43-08:00",
"disposition_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"type": "file_version_retention"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List file version retentions
{{baseUrl}}/file_version_retentions
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/file_version_retentions");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/file_version_retentions")
require "http/client"
url = "{{baseUrl}}/file_version_retentions"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/file_version_retentions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/file_version_retentions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/file_version_retentions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/file_version_retentions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/file_version_retentions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/file_version_retentions"))
.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}}/file_version_retentions")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/file_version_retentions")
.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}}/file_version_retentions');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/file_version_retentions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/file_version_retentions';
const options = {method: 'GET'};
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}}/file_version_retentions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/file_version_retentions")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/file_version_retentions',
headers: {}
};
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}}/file_version_retentions'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/file_version_retentions');
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}}/file_version_retentions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/file_version_retentions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/file_version_retentions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/file_version_retentions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/file_version_retentions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/file_version_retentions');
echo $response->getBody();
setUrl('{{baseUrl}}/file_version_retentions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/file_version_retentions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/file_version_retentions' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/file_version_retentions' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/file_version_retentions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/file_version_retentions"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/file_version_retentions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/file_version_retentions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/file_version_retentions') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/file_version_retentions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/file_version_retentions
http GET {{baseUrl}}/file_version_retentions
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/file_version_retentions
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/file_version_retentions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get file version
{{baseUrl}}/files/:file_id/versions/:file_version_id
QUERY PARAMS
file_id
file_version_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/versions/:file_version_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/versions/:file_version_id")
require "http/client"
url = "{{baseUrl}}/files/:file_id/versions/:file_version_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/versions/:file_version_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/versions/:file_version_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/versions/:file_version_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/versions/:file_version_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/versions/:file_version_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/versions/:file_version_id"))
.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}}/files/:file_id/versions/:file_version_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/versions/:file_version_id")
.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}}/files/:file_id/versions/:file_version_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id/versions/:file_version_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/versions/:file_version_id';
const options = {method: 'GET'};
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}}/files/:file_id/versions/:file_version_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/versions/:file_version_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/versions/:file_version_id',
headers: {}
};
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}}/files/:file_id/versions/:file_version_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/versions/:file_version_id');
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}}/files/:file_id/versions/:file_version_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/versions/:file_version_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/versions/:file_version_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/versions/:file_version_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/versions/:file_version_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/versions/:file_version_id');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/versions/:file_version_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/versions/:file_version_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/versions/:file_version_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/versions/:file_version_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/versions/:file_version_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/versions/:file_version_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/versions/:file_version_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/versions/:file_version_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/versions/:file_version_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/versions/:file_version_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/versions/:file_version_id
http GET {{baseUrl}}/files/:file_id/versions/:file_version_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/versions/:file_version_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/versions/:file_version_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List all file versions
{{baseUrl}}/files/:file_id/versions
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/versions");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/versions")
require "http/client"
url = "{{baseUrl}}/files/:file_id/versions"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/versions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/versions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/versions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/versions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/versions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/versions"))
.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}}/files/:file_id/versions")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/versions")
.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}}/files/:file_id/versions');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/files/:file_id/versions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/versions';
const options = {method: 'GET'};
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}}/files/:file_id/versions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/versions")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/versions',
headers: {}
};
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}}/files/:file_id/versions'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/versions');
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}}/files/:file_id/versions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/versions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/versions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/versions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/versions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/versions');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/versions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/versions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/versions' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/versions' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/versions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/versions"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/versions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/versions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/versions') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/versions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/versions
http GET {{baseUrl}}/files/:file_id/versions
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/versions
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/versions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Promote file version
{{baseUrl}}/files/:file_id/versions/current
QUERY PARAMS
file_id
BODY json
{
"id": "",
"type": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/versions/current");
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 \"id\": \"\",\n \"type\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id/versions/current" {:content-type :json
:form-params {:id ""
:type ""}})
require "http/client"
url = "{{baseUrl}}/files/:file_id/versions/current"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"id\": \"\",\n \"type\": \"\"\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}}/files/:file_id/versions/current"),
Content = new StringContent("{\n \"id\": \"\",\n \"type\": \"\"\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}}/files/:file_id/versions/current");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"id\": \"\",\n \"type\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/versions/current"
payload := strings.NewReader("{\n \"id\": \"\",\n \"type\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id/versions/current HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 28
{
"id": "",
"type": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id/versions/current")
.setHeader("content-type", "application/json")
.setBody("{\n \"id\": \"\",\n \"type\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/versions/current"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"id\": \"\",\n \"type\": \"\"\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 \"id\": \"\",\n \"type\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/versions/current")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id/versions/current")
.header("content-type", "application/json")
.body("{\n \"id\": \"\",\n \"type\": \"\"\n}")
.asString();
const data = JSON.stringify({
id: '',
type: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/:file_id/versions/current');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/versions/current',
headers: {'content-type': 'application/json'},
data: {id: '', type: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/versions/current';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"id":"","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}}/files/:file_id/versions/current',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "id": "",\n "type": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"id\": \"\",\n \"type\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/versions/current")
.post(body)
.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/files/:file_id/versions/current',
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({id: '', type: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/versions/current',
headers: {'content-type': 'application/json'},
body: {id: '', type: ''},
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}}/files/:file_id/versions/current');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
id: '',
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: 'POST',
url: '{{baseUrl}}/files/:file_id/versions/current',
headers: {'content-type': 'application/json'},
data: {id: '', type: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/versions/current';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"id": @"",
@"type": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/versions/current"]
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}}/files/:file_id/versions/current" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"id\": \"\",\n \"type\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/versions/current",
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([
'id' => '',
'type' => ''
]),
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('POST', '{{baseUrl}}/files/:file_id/versions/current', [
'body' => '{
"id": "",
"type": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/versions/current');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'id' => '',
'type' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'id' => '',
'type' => ''
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id/versions/current');
$request->setRequestMethod('POST');
$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}}/files/:file_id/versions/current' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"id": "",
"type": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/versions/current' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"id": "",
"type": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"id\": \"\",\n \"type\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/:file_id/versions/current", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/versions/current"
payload = {
"id": "",
"type": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/versions/current"
payload <- "{\n \"id\": \"\",\n \"type\": \"\"\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}}/files/:file_id/versions/current")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"id\": \"\",\n \"type\": \"\"\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/files/:file_id/versions/current') do |req|
req.body = "{\n \"id\": \"\",\n \"type\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/versions/current";
let payload = json!({
"id": "",
"type": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/:file_id/versions/current \
--header 'content-type: application/json' \
--data '{
"id": "",
"type": ""
}'
echo '{
"id": "",
"type": ""
}' | \
http POST {{baseUrl}}/files/:file_id/versions/current \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "id": "",\n "type": ""\n}' \
--output-document \
- {{baseUrl}}/files/:file_id/versions/current
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"id": "",
"type": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/versions/current")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove file version
{{baseUrl}}/files/:file_id/versions/:file_version_id
QUERY PARAMS
file_id
file_version_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/versions/:file_version_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/:file_id/versions/:file_version_id")
require "http/client"
url = "{{baseUrl}}/files/:file_id/versions/:file_version_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/versions/:file_version_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/versions/:file_version_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/versions/:file_version_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/:file_id/versions/:file_version_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/:file_id/versions/:file_version_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/versions/:file_version_id"))
.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}}/files/:file_id/versions/:file_version_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/:file_id/versions/:file_version_id")
.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}}/files/:file_id/versions/:file_version_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/files/:file_id/versions/:file_version_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/versions/:file_version_id';
const options = {method: 'DELETE'};
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}}/files/:file_id/versions/:file_version_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/versions/:file_version_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/versions/:file_version_id',
headers: {}
};
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}}/files/:file_id/versions/:file_version_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/:file_id/versions/:file_version_id');
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}}/files/:file_id/versions/:file_version_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/versions/:file_version_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/versions/:file_version_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/:file_id/versions/:file_version_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/versions/:file_version_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/:file_id/versions/:file_version_id');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/versions/:file_version_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/versions/:file_version_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/versions/:file_version_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/versions/:file_version_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/:file_id/versions/:file_version_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/versions/:file_version_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/versions/:file_version_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/versions/:file_version_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/:file_id/versions/:file_version_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/versions/:file_version_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/:file_id/versions/:file_version_id
http DELETE {{baseUrl}}/files/:file_id/versions/:file_version_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/:file_id/versions/:file_version_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/versions/:file_version_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Restore file version
{{baseUrl}}/files/:file_id/versions/:file_version_id
QUERY PARAMS
file_id
file_version_id
BODY json
{
"trashed_at": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/versions/:file_version_id");
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 \"trashed_at\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id/versions/:file_version_id" {:content-type :json
:form-params {:trashed_at ""}})
require "http/client"
url = "{{baseUrl}}/files/:file_id/versions/:file_version_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"trashed_at\": \"\"\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}}/files/:file_id/versions/:file_version_id"),
Content = new StringContent("{\n \"trashed_at\": \"\"\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}}/files/:file_id/versions/:file_version_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"trashed_at\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/versions/:file_version_id"
payload := strings.NewReader("{\n \"trashed_at\": \"\"\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/files/:file_id/versions/:file_version_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 22
{
"trashed_at": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id/versions/:file_version_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"trashed_at\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/versions/:file_version_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"trashed_at\": \"\"\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 \"trashed_at\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/versions/:file_version_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id/versions/:file_version_id")
.header("content-type", "application/json")
.body("{\n \"trashed_at\": \"\"\n}")
.asString();
const data = JSON.stringify({
trashed_at: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/files/:file_id/versions/:file_version_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id/versions/:file_version_id',
headers: {'content-type': 'application/json'},
data: {trashed_at: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/versions/:file_version_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"trashed_at":""}'
};
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}}/files/:file_id/versions/:file_version_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "trashed_at": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"trashed_at\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/versions/:file_version_id")
.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/files/:file_id/versions/:file_version_id',
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({trashed_at: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id/versions/:file_version_id',
headers: {'content-type': 'application/json'},
body: {trashed_at: ''},
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}}/files/:file_id/versions/:file_version_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
trashed_at: ''
});
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}}/files/:file_id/versions/:file_version_id',
headers: {'content-type': 'application/json'},
data: {trashed_at: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/versions/:file_version_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"trashed_at":""}'
};
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 = @{ @"trashed_at": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/versions/:file_version_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}}/files/:file_id/versions/:file_version_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"trashed_at\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/versions/:file_version_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([
'trashed_at' => ''
]),
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}}/files/:file_id/versions/:file_version_id', [
'body' => '{
"trashed_at": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/versions/:file_version_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'trashed_at' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'trashed_at' => ''
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id/versions/:file_version_id');
$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}}/files/:file_id/versions/:file_version_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"trashed_at": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/versions/:file_version_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"trashed_at": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"trashed_at\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/files/:file_id/versions/:file_version_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/versions/:file_version_id"
payload = { "trashed_at": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/versions/:file_version_id"
payload <- "{\n \"trashed_at\": \"\"\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}}/files/:file_id/versions/:file_version_id")
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 \"trashed_at\": \"\"\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/files/:file_id/versions/:file_version_id') do |req|
req.body = "{\n \"trashed_at\": \"\"\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}}/files/:file_id/versions/:file_version_id";
let payload = json!({"trashed_at": ""});
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}}/files/:file_id/versions/:file_version_id \
--header 'content-type: application/json' \
--data '{
"trashed_at": ""
}'
echo '{
"trashed_at": ""
}' | \
http PUT {{baseUrl}}/files/:file_id/versions/:file_version_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "trashed_at": ""\n}' \
--output-document \
- {{baseUrl}}/files/:file_id/versions/:file_version_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["trashed_at": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/versions/:file_version_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Copy file
{{baseUrl}}/files/:file_id/copy
QUERY PARAMS
file_id
BODY json
{
"name": "",
"parent": {
"id": ""
},
"version": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/copy");
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 \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id/copy" {:content-type :json
:form-params {:name ""
:parent {:id ""}
:version ""}})
require "http/client"
url = "{{baseUrl}}/files/:file_id/copy"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\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}}/files/:file_id/copy"),
Content = new StringContent("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\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}}/files/:file_id/copy");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/copy"
payload := strings.NewReader("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id/copy HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 65
{
"name": "",
"parent": {
"id": ""
},
"version": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id/copy")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/copy"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\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 \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/copy")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id/copy")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}")
.asString();
const data = JSON.stringify({
name: '',
parent: {
id: ''
},
version: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/:file_id/copy');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/copy',
headers: {'content-type': 'application/json'},
data: {name: '', parent: {id: ''}, version: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/copy';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":{"id":""},"version":""}'
};
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}}/files/:file_id/copy',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "parent": {\n "id": ""\n },\n "version": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/copy")
.post(body)
.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/files/:file_id/copy',
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({name: '', parent: {id: ''}, version: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/copy',
headers: {'content-type': 'application/json'},
body: {name: '', parent: {id: ''}, version: ''},
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}}/files/:file_id/copy');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
parent: {
id: ''
},
version: ''
});
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}}/files/:file_id/copy',
headers: {'content-type': 'application/json'},
data: {name: '', parent: {id: ''}, version: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/copy';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":{"id":""},"version":""}'
};
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 = @{ @"name": @"",
@"parent": @{ @"id": @"" },
@"version": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/copy"]
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}}/files/:file_id/copy" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/copy",
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' => '',
'parent' => [
'id' => ''
],
'version' => ''
]),
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('POST', '{{baseUrl}}/files/:file_id/copy', [
'body' => '{
"name": "",
"parent": {
"id": ""
},
"version": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/copy');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'parent' => [
'id' => ''
],
'version' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'name' => '',
'parent' => [
'id' => ''
],
'version' => ''
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id/copy');
$request->setRequestMethod('POST');
$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}}/files/:file_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": {
"id": ""
},
"version": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": {
"id": ""
},
"version": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/:file_id/copy", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/copy"
payload = {
"name": "",
"parent": { "id": "" },
"version": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/copy"
payload <- "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\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}}/files/:file_id/copy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\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/files/:file_id/copy') do |req|
req.body = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"version\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/copy";
let payload = json!({
"name": "",
"parent": json!({"id": ""}),
"version": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/:file_id/copy \
--header 'content-type: application/json' \
--data '{
"name": "",
"parent": {
"id": ""
},
"version": ""
}'
echo '{
"name": "",
"parent": {
"id": ""
},
"version": ""
}' | \
http POST {{baseUrl}}/files/:file_id/copy \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "parent": {\n "id": ""\n },\n "version": ""\n}' \
--output-document \
- {{baseUrl}}/files/:file_id/copy
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"parent": ["id": ""],
"version": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/copy")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete file
{{baseUrl}}/files/:file_id
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/:file_id")
require "http/client"
url = "{{baseUrl}}/files/:file_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/:file_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/:file_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/:file_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id"))
.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}}/files/:file_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/:file_id")
.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}}/files/:file_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/files/:file_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id';
const options = {method: 'DELETE'};
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}}/files/:file_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id',
headers: {}
};
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}}/files/:file_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/:file_id');
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}}/files/:file_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/:file_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/:file_id');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/:file_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/:file_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/:file_id
http DELETE {{baseUrl}}/files/:file_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/:file_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get file information
{{baseUrl}}/files/:file_id
HEADERS
x-rep-hints
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-rep-hints: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id" {:headers {:x-rep-hints ""}})
require "http/client"
url = "{{baseUrl}}/files/:file_id"
headers = HTTP::Headers{
"x-rep-hints" => ""
}
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}}/files/:file_id"),
Headers =
{
{ "x-rep-hints", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id");
var request = new RestRequest("", Method.Get);
request.AddHeader("x-rep-hints", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rep-hints", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id HTTP/1.1
X-Rep-Hints:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id")
.setHeader("x-rep-hints", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id"))
.header("x-rep-hints", "")
.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}}/files/:file_id")
.get()
.addHeader("x-rep-hints", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id")
.header("x-rep-hints", "")
.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}}/files/:file_id');
xhr.setRequestHeader('x-rep-hints', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id',
headers: {'x-rep-hints': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id';
const options = {method: 'GET', headers: {'x-rep-hints': ''}};
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}}/files/:file_id',
method: 'GET',
headers: {
'x-rep-hints': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id")
.get()
.addHeader("x-rep-hints", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id',
headers: {
'x-rep-hints': ''
}
};
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}}/files/:file_id',
headers: {'x-rep-hints': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id');
req.headers({
'x-rep-hints': ''
});
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}}/files/:file_id',
headers: {'x-rep-hints': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id';
const options = {method: 'GET', headers: {'x-rep-hints': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-rep-hints": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_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}}/files/:file_id" in
let headers = Header.add (Header.init ()) "x-rep-hints" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_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 => [
"x-rep-hints: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id', [
'headers' => [
'x-rep-hints' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'x-rep-hints' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id');
$request->setRequestMethod('GET');
$request->setHeaders([
'x-rep-hints' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-rep-hints", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id' -Method GET -Headers $headers
$headers=@{}
$headers.Add("x-rep-hints", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-rep-hints': "" }
conn.request("GET", "/baseUrl/files/:file_id", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id"
headers = {"x-rep-hints": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id"
response <- VERB("GET", url, add_headers('x-rep-hints' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rep-hints"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id') do |req|
req.headers['x-rep-hints'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-rep-hints", "".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}}/files/:file_id \
--header 'x-rep-hints: '
http GET {{baseUrl}}/files/:file_id \
x-rep-hints:''
wget --quiet \
--method GET \
--header 'x-rep-hints: ' \
--output-document \
- {{baseUrl}}/files/:file_id
import Foundation
let headers = ["x-rep-hints": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get file thumbnail
{{baseUrl}}/files/:file_id/thumbnail.:extension
QUERY PARAMS
file_id
extension
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/thumbnail.:extension");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/thumbnail.:extension")
require "http/client"
url = "{{baseUrl}}/files/:file_id/thumbnail.:extension"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/thumbnail.:extension"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/thumbnail.:extension");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/thumbnail.:extension"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/thumbnail.:extension HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/thumbnail.:extension")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/thumbnail.:extension"))
.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}}/files/:file_id/thumbnail.:extension")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/thumbnail.:extension")
.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}}/files/:file_id/thumbnail.:extension');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id/thumbnail.:extension'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/thumbnail.:extension';
const options = {method: 'GET'};
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}}/files/:file_id/thumbnail.:extension',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/thumbnail.:extension")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/thumbnail.:extension',
headers: {}
};
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}}/files/:file_id/thumbnail.:extension'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/thumbnail.:extension');
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}}/files/:file_id/thumbnail.:extension'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/thumbnail.:extension';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/thumbnail.:extension"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/thumbnail.:extension" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/thumbnail.:extension",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/thumbnail.:extension');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/thumbnail.:extension');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/thumbnail.:extension');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/thumbnail.:extension' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/thumbnail.:extension' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/thumbnail.:extension")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/thumbnail.:extension"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/thumbnail.:extension"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/thumbnail.:extension")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/thumbnail.:extension') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/thumbnail.:extension";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/thumbnail.:extension
http GET {{baseUrl}}/files/:file_id/thumbnail.:extension
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/thumbnail.:extension
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/thumbnail.:extension")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
OPTIONS
Preflight check before upload
{{baseUrl}}/files/content
BODY json
{
"name": "",
"parent": "",
"size": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "OPTIONS");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/content");
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 \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/options "{{baseUrl}}/files/content" {:content-type :json
:form-params {:name ""
:parent ""
:size 0}})
require "http/client"
url = "{{baseUrl}}/files/content"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}"
response = HTTP::Client.options url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Options,
RequestUri = new Uri("{{baseUrl}}/files/content"),
Content = new StringContent("{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\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}}/files/content");
var request = new RestRequest("", Method.Options);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/content"
payload := strings.NewReader("{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}")
req, _ := http.NewRequest("OPTIONS", 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))
}
OPTIONS /baseUrl/files/content HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 45
{
"name": "",
"parent": "",
"size": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("OPTIONS", "{{baseUrl}}/files/content")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/content"))
.header("content-type", "application/json")
.method("OPTIONS", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\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 \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/content")
.method("OPTIONS", body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.options("{{baseUrl}}/files/content")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}")
.asString();
const data = JSON.stringify({
name: '',
parent: '',
size: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('OPTIONS', '{{baseUrl}}/files/content');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'OPTIONS',
url: '{{baseUrl}}/files/content',
headers: {'content-type': 'application/json'},
data: {name: '', parent: '', size: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/content';
const options = {
method: 'OPTIONS',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":"","size":0}'
};
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}}/files/content',
method: 'OPTIONS',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "parent": "",\n "size": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/content")
.method("OPTIONS", body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'OPTIONS',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/content',
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({name: '', parent: '', size: 0}));
req.end();
const request = require('request');
const options = {
method: 'OPTIONS',
url: '{{baseUrl}}/files/content',
headers: {'content-type': 'application/json'},
body: {name: '', parent: '', size: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('OPTIONS', '{{baseUrl}}/files/content');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
parent: '',
size: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'OPTIONS',
url: '{{baseUrl}}/files/content',
headers: {'content-type': 'application/json'},
data: {name: '', parent: '', size: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/content';
const options = {
method: 'OPTIONS',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":"","size":0}'
};
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 = @{ @"name": @"",
@"parent": @"",
@"size": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/content"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"OPTIONS"];
[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}}/files/content" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}" in
Client.call ~headers ~body `OPTIONS uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/content",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "OPTIONS",
CURLOPT_POSTFIELDS => json_encode([
'name' => '',
'parent' => '',
'size' => 0
]),
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('OPTIONS', '{{baseUrl}}/files/content', [
'body' => '{
"name": "",
"parent": "",
"size": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/content');
$request->setMethod(HTTP_METH_OPTIONS);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'parent' => '',
'size' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'name' => '',
'parent' => '',
'size' => 0
]));
$request->setRequestUrl('{{baseUrl}}/files/content');
$request->setRequestMethod('OPTIONS');
$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}}/files/content' -Method OPTIONS -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": "",
"size": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/content' -Method OPTIONS -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": "",
"size": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("OPTIONS", "/baseUrl/files/content", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/content"
payload = {
"name": "",
"parent": "",
"size": 0
}
headers = {"content-type": "application/json"}
response = requests.options(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/content"
payload <- "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\n}"
encode <- "json"
response <- VERB("OPTIONS", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/content")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Options.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\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.options('/baseUrl/files/content') do |req|
req.body = "{\n \"name\": \"\",\n \"parent\": \"\",\n \"size\": 0\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}}/files/content";
let payload = json!({
"name": "",
"parent": "",
"size": 0
});
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("OPTIONS").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request OPTIONS \
--url {{baseUrl}}/files/content \
--header 'content-type: application/json' \
--data '{
"name": "",
"parent": "",
"size": 0
}'
echo '{
"name": "",
"parent": "",
"size": 0
}' | \
http OPTIONS {{baseUrl}}/files/content \
content-type:application/json
wget --quiet \
--method OPTIONS \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "parent": "",\n "size": 0\n}' \
--output-document \
- {{baseUrl}}/files/content
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"parent": "",
"size": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/content")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "OPTIONS"
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
{
"upload_token": "Pc3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQP",
"upload_url": "https://upload-las.app.box.com/api/2.0/files/content?upload_session_id=1234"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update file
{{baseUrl}}/files/:file_id
QUERY PARAMS
file_id
BODY json
{
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": false
},
"name": "",
"parent": "",
"permissions": {
"can_download": ""
},
"shared_link": "",
"tags": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id");
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 \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id" {:content-type :json
:form-params {:description ""
:disposition_at ""
:lock {:access ""
:expires_at ""
:is_download_prevented false}
:name ""
:parent ""
:permissions {:can_download ""}
:shared_link ""
:tags []}})
require "http/client"
url = "{{baseUrl}}/files/:file_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\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}}/files/:file_id"),
Content = new StringContent("{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\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}}/files/:file_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id"
payload := strings.NewReader("{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\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/files/:file_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 251
{
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": false
},
"name": "",
"parent": "",
"permissions": {
"can_download": ""
},
"shared_link": "",
"tags": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\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 \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}")
.asString();
const data = JSON.stringify({
description: '',
disposition_at: '',
lock: {
access: '',
expires_at: '',
is_download_prevented: false
},
name: '',
parent: '',
permissions: {
can_download: ''
},
shared_link: '',
tags: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/files/:file_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
disposition_at: '',
lock: {access: '', expires_at: '', is_download_prevented: false},
name: '',
parent: '',
permissions: {can_download: ''},
shared_link: '',
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","disposition_at":"","lock":{"access":"","expires_at":"","is_download_prevented":false},"name":"","parent":"","permissions":{"can_download":""},"shared_link":"","tags":[]}'
};
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}}/files/:file_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "disposition_at": "",\n "lock": {\n "access": "",\n "expires_at": "",\n "is_download_prevented": false\n },\n "name": "",\n "parent": "",\n "permissions": {\n "can_download": ""\n },\n "shared_link": "",\n "tags": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id")
.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/files/:file_id',
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({
description: '',
disposition_at: '',
lock: {access: '', expires_at: '', is_download_prevented: false},
name: '',
parent: '',
permissions: {can_download: ''},
shared_link: '',
tags: []
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id',
headers: {'content-type': 'application/json'},
body: {
description: '',
disposition_at: '',
lock: {access: '', expires_at: '', is_download_prevented: false},
name: '',
parent: '',
permissions: {can_download: ''},
shared_link: '',
tags: []
},
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}}/files/:file_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
disposition_at: '',
lock: {
access: '',
expires_at: '',
is_download_prevented: false
},
name: '',
parent: '',
permissions: {
can_download: ''
},
shared_link: '',
tags: []
});
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}}/files/:file_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
disposition_at: '',
lock: {access: '', expires_at: '', is_download_prevented: false},
name: '',
parent: '',
permissions: {can_download: ''},
shared_link: '',
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","disposition_at":"","lock":{"access":"","expires_at":"","is_download_prevented":false},"name":"","parent":"","permissions":{"can_download":""},"shared_link":"","tags":[]}'
};
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 = @{ @"description": @"",
@"disposition_at": @"",
@"lock": @{ @"access": @"", @"expires_at": @"", @"is_download_prevented": @NO },
@"name": @"",
@"parent": @"",
@"permissions": @{ @"can_download": @"" },
@"shared_link": @"",
@"tags": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_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}}/files/:file_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_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([
'description' => '',
'disposition_at' => '',
'lock' => [
'access' => '',
'expires_at' => '',
'is_download_prevented' => null
],
'name' => '',
'parent' => '',
'permissions' => [
'can_download' => ''
],
'shared_link' => '',
'tags' => [
]
]),
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}}/files/:file_id', [
'body' => '{
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": false
},
"name": "",
"parent": "",
"permissions": {
"can_download": ""
},
"shared_link": "",
"tags": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'disposition_at' => '',
'lock' => [
'access' => '',
'expires_at' => '',
'is_download_prevented' => null
],
'name' => '',
'parent' => '',
'permissions' => [
'can_download' => ''
],
'shared_link' => '',
'tags' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'disposition_at' => '',
'lock' => [
'access' => '',
'expires_at' => '',
'is_download_prevented' => null
],
'name' => '',
'parent' => '',
'permissions' => [
'can_download' => ''
],
'shared_link' => '',
'tags' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id');
$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}}/files/:file_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": false
},
"name": "",
"parent": "",
"permissions": {
"can_download": ""
},
"shared_link": "",
"tags": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": false
},
"name": "",
"parent": "",
"permissions": {
"can_download": ""
},
"shared_link": "",
"tags": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/files/:file_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id"
payload = {
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": False
},
"name": "",
"parent": "",
"permissions": { "can_download": "" },
"shared_link": "",
"tags": []
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id"
payload <- "{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\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}}/files/:file_id")
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 \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\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/files/:file_id') do |req|
req.body = "{\n \"description\": \"\",\n \"disposition_at\": \"\",\n \"lock\": {\n \"access\": \"\",\n \"expires_at\": \"\",\n \"is_download_prevented\": false\n },\n \"name\": \"\",\n \"parent\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n },\n \"shared_link\": \"\",\n \"tags\": []\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}}/files/:file_id";
let payload = json!({
"description": "",
"disposition_at": "",
"lock": json!({
"access": "",
"expires_at": "",
"is_download_prevented": false
}),
"name": "",
"parent": "",
"permissions": json!({"can_download": ""}),
"shared_link": "",
"tags": ()
});
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}}/files/:file_id \
--header 'content-type: application/json' \
--data '{
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": false
},
"name": "",
"parent": "",
"permissions": {
"can_download": ""
},
"shared_link": "",
"tags": []
}'
echo '{
"description": "",
"disposition_at": "",
"lock": {
"access": "",
"expires_at": "",
"is_download_prevented": false
},
"name": "",
"parent": "",
"permissions": {
"can_download": ""
},
"shared_link": "",
"tags": []
}' | \
http PUT {{baseUrl}}/files/:file_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "disposition_at": "",\n "lock": {\n "access": "",\n "expires_at": "",\n "is_download_prevented": false\n },\n "name": "",\n "parent": "",\n "permissions": {\n "can_download": ""\n },\n "shared_link": "",\n "tags": []\n}' \
--output-document \
- {{baseUrl}}/files/:file_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"disposition_at": "",
"lock": [
"access": "",
"expires_at": "",
"is_download_prevented": false
],
"name": "",
"parent": "",
"permissions": ["can_download": ""],
"shared_link": "",
"tags": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create folder lock
{{baseUrl}}/folder_locks
BODY json
{
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": false,
"move": false
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folder_locks");
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 \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folder_locks" {:content-type :json
:form-params {:folder {:id ""
:type ""}
:locked_operations {:delete false
:move false}}})
require "http/client"
url = "{{baseUrl}}/folder_locks"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\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}}/folder_locks"),
Content = new StringContent("{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\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}}/folder_locks");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folder_locks"
payload := strings.NewReader("{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/folder_locks HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 119
{
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": false,
"move": false
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folder_locks")
.setHeader("content-type", "application/json")
.setBody("{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folder_locks"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\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 \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folder_locks")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/folder_locks")
.header("content-type", "application/json")
.body("{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}")
.asString();
const data = JSON.stringify({
folder: {
id: '',
type: ''
},
locked_operations: {
delete: false,
move: false
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folder_locks');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folder_locks',
headers: {'content-type': 'application/json'},
data: {folder: {id: '', type: ''}, locked_operations: {delete: false, move: false}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folder_locks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder":{"id":"","type":""},"locked_operations":{"delete":false,"move":false}}'
};
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}}/folder_locks',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "folder": {\n "id": "",\n "type": ""\n },\n "locked_operations": {\n "delete": false,\n "move": false\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 \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folder_locks")
.post(body)
.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/folder_locks',
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({folder: {id: '', type: ''}, locked_operations: {delete: false, move: false}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folder_locks',
headers: {'content-type': 'application/json'},
body: {folder: {id: '', type: ''}, locked_operations: {delete: false, move: false}},
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}}/folder_locks');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
folder: {
id: '',
type: ''
},
locked_operations: {
delete: false,
move: false
}
});
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}}/folder_locks',
headers: {'content-type': 'application/json'},
data: {folder: {id: '', type: ''}, locked_operations: {delete: false, move: false}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folder_locks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder":{"id":"","type":""},"locked_operations":{"delete":false,"move":false}}'
};
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 = @{ @"folder": @{ @"id": @"", @"type": @"" },
@"locked_operations": @{ @"delete": @NO, @"move": @NO } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folder_locks"]
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}}/folder_locks" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folder_locks",
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([
'folder' => [
'id' => '',
'type' => ''
],
'locked_operations' => [
'delete' => null,
'move' => null
]
]),
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('POST', '{{baseUrl}}/folder_locks', [
'body' => '{
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": false,
"move": false
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folder_locks');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'folder' => [
'id' => '',
'type' => ''
],
'locked_operations' => [
'delete' => null,
'move' => null
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'folder' => [
'id' => '',
'type' => ''
],
'locked_operations' => [
'delete' => null,
'move' => null
]
]));
$request->setRequestUrl('{{baseUrl}}/folder_locks');
$request->setRequestMethod('POST');
$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}}/folder_locks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": false,
"move": false
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folder_locks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": false,
"move": false
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folder_locks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folder_locks"
payload = {
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": False,
"move": False
}
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folder_locks"
payload <- "{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\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}}/folder_locks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\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/folder_locks') do |req|
req.body = "{\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"locked_operations\": {\n \"delete\": false,\n \"move\": false\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folder_locks";
let payload = json!({
"folder": json!({
"id": "",
"type": ""
}),
"locked_operations": json!({
"delete": false,
"move": false
})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/folder_locks \
--header 'content-type: application/json' \
--data '{
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": false,
"move": false
}
}'
echo '{
"folder": {
"id": "",
"type": ""
},
"locked_operations": {
"delete": false,
"move": false
}
}' | \
http POST {{baseUrl}}/folder_locks \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "folder": {\n "id": "",\n "type": ""\n },\n "locked_operations": {\n "delete": false,\n "move": false\n }\n}' \
--output-document \
- {{baseUrl}}/folder_locks
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"folder": [
"id": "",
"type": ""
],
"locked_operations": [
"delete": false,
"move": false
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folder_locks")! 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
{
"created_at": "2020-09-14T23:12:53Z",
"id": "12345678",
"lock_type": "freeze",
"locked_operations": {
"delete": true,
"move": true
},
"type": "folder_lock"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete folder lock
{{baseUrl}}/folder_locks/:folder_lock_id
QUERY PARAMS
folder_lock_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folder_locks/:folder_lock_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/folder_locks/:folder_lock_id")
require "http/client"
url = "{{baseUrl}}/folder_locks/:folder_lock_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/folder_locks/:folder_lock_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folder_locks/:folder_lock_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folder_locks/:folder_lock_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/folder_locks/:folder_lock_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/folder_locks/:folder_lock_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folder_locks/:folder_lock_id"))
.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}}/folder_locks/:folder_lock_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/folder_locks/:folder_lock_id")
.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}}/folder_locks/:folder_lock_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/folder_locks/:folder_lock_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folder_locks/:folder_lock_id';
const options = {method: 'DELETE'};
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}}/folder_locks/:folder_lock_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folder_locks/:folder_lock_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/folder_locks/:folder_lock_id',
headers: {}
};
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}}/folder_locks/:folder_lock_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/folder_locks/:folder_lock_id');
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}}/folder_locks/:folder_lock_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folder_locks/:folder_lock_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folder_locks/:folder_lock_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/folder_locks/:folder_lock_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folder_locks/:folder_lock_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/folder_locks/:folder_lock_id');
echo $response->getBody();
setUrl('{{baseUrl}}/folder_locks/:folder_lock_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folder_locks/:folder_lock_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folder_locks/:folder_lock_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folder_locks/:folder_lock_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/folder_locks/:folder_lock_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folder_locks/:folder_lock_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folder_locks/:folder_lock_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folder_locks/:folder_lock_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/folder_locks/:folder_lock_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folder_locks/:folder_lock_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/folder_locks/:folder_lock_id
http DELETE {{baseUrl}}/folder_locks/:folder_lock_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/folder_locks/:folder_lock_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folder_locks/:folder_lock_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List folder locks
{{baseUrl}}/folder_locks
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folder_locks?folder_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folder_locks" {:query-params {:folder_id ""}})
require "http/client"
url = "{{baseUrl}}/folder_locks?folder_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folder_locks?folder_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folder_locks?folder_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folder_locks?folder_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folder_locks?folder_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folder_locks?folder_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folder_locks?folder_id="))
.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}}/folder_locks?folder_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folder_locks?folder_id=")
.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}}/folder_locks?folder_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/folder_locks',
params: {folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folder_locks?folder_id=';
const options = {method: 'GET'};
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}}/folder_locks?folder_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folder_locks?folder_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folder_locks?folder_id=',
headers: {}
};
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}}/folder_locks',
qs: {folder_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folder_locks');
req.query({
folder_id: ''
});
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}}/folder_locks',
params: {folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folder_locks?folder_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folder_locks?folder_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folder_locks?folder_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folder_locks?folder_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folder_locks?folder_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/folder_locks');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'folder_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folder_locks');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'folder_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folder_locks?folder_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folder_locks?folder_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folder_locks?folder_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folder_locks"
querystring = {"folder_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folder_locks"
queryString <- list(folder_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folder_locks?folder_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folder_locks') do |req|
req.params['folder_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folder_locks";
let querystring = [
("folder_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/folder_locks?folder_id='
http GET '{{baseUrl}}/folder_locks?folder_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/folder_locks?folder_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folder_locks?folder_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Copy folder
{{baseUrl}}/folders/:folder_id/copy
QUERY PARAMS
folder_id
BODY json
{
"name": "",
"parent": {
"id": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/copy");
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 \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders/:folder_id/copy" {:content-type :json
:form-params {:name ""
:parent {:id ""}}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/copy"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\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}}/folders/:folder_id/copy"),
Content = new StringContent("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\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}}/folders/:folder_id/copy");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/copy"
payload := strings.NewReader("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/folders/:folder_id/copy HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 48
{
"name": "",
"parent": {
"id": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders/:folder_id/copy")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/copy"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\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 \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/copy")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/folders/:folder_id/copy")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
name: '',
parent: {
id: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folders/:folder_id/copy');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/copy',
headers: {'content-type': 'application/json'},
data: {name: '', parent: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/copy';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":{"id":""}}'
};
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}}/folders/:folder_id/copy',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "parent": {\n "id": ""\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 \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/copy")
.post(body)
.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/folders/:folder_id/copy',
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({name: '', parent: {id: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/copy',
headers: {'content-type': 'application/json'},
body: {name: '', parent: {id: ''}},
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}}/folders/:folder_id/copy');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
parent: {
id: ''
}
});
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}}/folders/:folder_id/copy',
headers: {'content-type': 'application/json'},
data: {name: '', parent: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/copy';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":{"id":""}}'
};
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 = @{ @"name": @"",
@"parent": @{ @"id": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/copy"]
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}}/folders/:folder_id/copy" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/copy",
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' => '',
'parent' => [
'id' => ''
]
]),
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('POST', '{{baseUrl}}/folders/:folder_id/copy', [
'body' => '{
"name": "",
"parent": {
"id": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/copy');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'parent' => [
'id' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'name' => '',
'parent' => [
'id' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id/copy');
$request->setRequestMethod('POST');
$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}}/folders/:folder_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": {
"id": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": {
"id": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders/:folder_id/copy", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/copy"
payload = {
"name": "",
"parent": { "id": "" }
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/copy"
payload <- "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\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}}/folders/:folder_id/copy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\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/folders/:folder_id/copy') do |req|
req.body = "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/copy";
let payload = json!({
"name": "",
"parent": json!({"id": ""})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/folders/:folder_id/copy \
--header 'content-type: application/json' \
--data '{
"name": "",
"parent": {
"id": ""
}
}'
echo '{
"name": "",
"parent": {
"id": ""
}
}' | \
http POST {{baseUrl}}/folders/:folder_id/copy \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "parent": {\n "id": ""\n }\n}' \
--output-document \
- {{baseUrl}}/folders/:folder_id/copy
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"parent": ["id": ""]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/copy")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create folder
{{baseUrl}}/folders
BODY json
{
"folder_upload_email": "",
"name": "",
"parent": {
"id": ""
},
"sync_state": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders");
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 \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders" {:content-type :json
:form-params {:folder_upload_email ""
:name ""
:parent {:id ""}
:sync_state ""}})
require "http/client"
url = "{{baseUrl}}/folders"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\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}}/folders"),
Content = new StringContent("{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\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}}/folders");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders"
payload := strings.NewReader("{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/folders HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 97
{
"folder_upload_email": "",
"name": "",
"parent": {
"id": ""
},
"sync_state": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders")
.setHeader("content-type", "application/json")
.setBody("{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\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 \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/folders")
.header("content-type", "application/json")
.body("{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}")
.asString();
const data = JSON.stringify({
folder_upload_email: '',
name: '',
parent: {
id: ''
},
sync_state: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folders');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders',
headers: {'content-type': 'application/json'},
data: {folder_upload_email: '', name: '', parent: {id: ''}, sync_state: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder_upload_email":"","name":"","parent":{"id":""},"sync_state":""}'
};
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}}/folders',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "folder_upload_email": "",\n "name": "",\n "parent": {\n "id": ""\n },\n "sync_state": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders")
.post(body)
.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/folders',
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({folder_upload_email: '', name: '', parent: {id: ''}, sync_state: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders',
headers: {'content-type': 'application/json'},
body: {folder_upload_email: '', name: '', parent: {id: ''}, sync_state: ''},
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}}/folders');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
folder_upload_email: '',
name: '',
parent: {
id: ''
},
sync_state: ''
});
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}}/folders',
headers: {'content-type': 'application/json'},
data: {folder_upload_email: '', name: '', parent: {id: ''}, sync_state: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder_upload_email":"","name":"","parent":{"id":""},"sync_state":""}'
};
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 = @{ @"folder_upload_email": @"",
@"name": @"",
@"parent": @{ @"id": @"" },
@"sync_state": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders"]
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}}/folders" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders",
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([
'folder_upload_email' => '',
'name' => '',
'parent' => [
'id' => ''
],
'sync_state' => ''
]),
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('POST', '{{baseUrl}}/folders', [
'body' => '{
"folder_upload_email": "",
"name": "",
"parent": {
"id": ""
},
"sync_state": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'folder_upload_email' => '',
'name' => '',
'parent' => [
'id' => ''
],
'sync_state' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'folder_upload_email' => '',
'name' => '',
'parent' => [
'id' => ''
],
'sync_state' => ''
]));
$request->setRequestUrl('{{baseUrl}}/folders');
$request->setRequestMethod('POST');
$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}}/folders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder_upload_email": "",
"name": "",
"parent": {
"id": ""
},
"sync_state": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder_upload_email": "",
"name": "",
"parent": {
"id": ""
},
"sync_state": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders"
payload = {
"folder_upload_email": "",
"name": "",
"parent": { "id": "" },
"sync_state": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders"
payload <- "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\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}}/folders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\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/folders') do |req|
req.body = "{\n \"folder_upload_email\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"sync_state\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders";
let payload = json!({
"folder_upload_email": "",
"name": "",
"parent": json!({"id": ""}),
"sync_state": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/folders \
--header 'content-type: application/json' \
--data '{
"folder_upload_email": "",
"name": "",
"parent": {
"id": ""
},
"sync_state": ""
}'
echo '{
"folder_upload_email": "",
"name": "",
"parent": {
"id": ""
},
"sync_state": ""
}' | \
http POST {{baseUrl}}/folders \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "folder_upload_email": "",\n "name": "",\n "parent": {\n "id": ""\n },\n "sync_state": ""\n}' \
--output-document \
- {{baseUrl}}/folders
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"folder_upload_email": "",
"name": "",
"parent": ["id": ""],
"sync_state": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete folder
{{baseUrl}}/folders/:folder_id
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/folders/:folder_id")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/folders/:folder_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/folders/:folder_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id"))
.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}}/folders/:folder_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/folders/:folder_id")
.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}}/folders/:folder_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/folders/:folder_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id';
const options = {method: 'DELETE'};
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}}/folders/:folder_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id',
headers: {}
};
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}}/folders/:folder_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/folders/:folder_id');
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}}/folders/:folder_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/folders/:folder_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/folders/:folder_id');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/folders/:folder_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/folders/:folder_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/folders/:folder_id
http DELETE {{baseUrl}}/folders/:folder_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/folders/:folder_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get folder information
{{baseUrl}}/folders/:folder_id
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id"))
.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}}/folders/:folder_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id")
.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}}/folders/:folder_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/folders/:folder_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id';
const options = {method: 'GET'};
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}}/folders/:folder_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id',
headers: {}
};
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}}/folders/:folder_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id');
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}}/folders/:folder_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id
http GET {{baseUrl}}/folders/:folder_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List items in folder
{{baseUrl}}/folders/:folder_id/items
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/items");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id/items")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/items"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/items"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/items");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/items"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id/items HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id/items")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/items"))
.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}}/folders/:folder_id/items")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id/items")
.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}}/folders/:folder_id/items');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/folders/:folder_id/items'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/items';
const options = {method: 'GET'};
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}}/folders/:folder_id/items',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/items")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/items',
headers: {}
};
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}}/folders/:folder_id/items'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id/items');
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}}/folders/:folder_id/items'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/items';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/items"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id/items" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id/items');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/items');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/items');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/items' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/items' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id/items")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/items"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/items"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id/items') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/items";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id/items
http GET {{baseUrl}}/folders/:folder_id/items
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id/items
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/items")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update folder
{{baseUrl}}/folders/:folder_id
QUERY PARAMS
folder_id
BODY json
{
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": {
"id": ""
},
"shared_link": "",
"sync_state": "",
"tags": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id");
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 \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/folders/:folder_id" {:content-type :json
:form-params {:can_non_owners_invite false
:can_non_owners_view_collaborators false
:collections [{:id ""
:type ""}]
:description ""
:folder_upload_email ""
:is_collaboration_restricted_to_enterprise false
:name ""
:parent {:id ""}
:shared_link ""
:sync_state ""
:tags []}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\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}}/folders/:folder_id"),
Content = new StringContent("{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\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}}/folders/:folder_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id"
payload := strings.NewReader("{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\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/folders/:folder_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 356
{
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": {
"id": ""
},
"shared_link": "",
"sync_state": "",
"tags": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/folders/:folder_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\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 \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/folders/:folder_id")
.header("content-type", "application/json")
.body("{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}")
.asString();
const data = JSON.stringify({
can_non_owners_invite: false,
can_non_owners_view_collaborators: false,
collections: [
{
id: '',
type: ''
}
],
description: '',
folder_upload_email: '',
is_collaboration_restricted_to_enterprise: false,
name: '',
parent: {
id: ''
},
shared_link: '',
sync_state: '',
tags: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/folders/:folder_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id',
headers: {'content-type': 'application/json'},
data: {
can_non_owners_invite: false,
can_non_owners_view_collaborators: false,
collections: [{id: '', type: ''}],
description: '',
folder_upload_email: '',
is_collaboration_restricted_to_enterprise: false,
name: '',
parent: {id: ''},
shared_link: '',
sync_state: '',
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"can_non_owners_invite":false,"can_non_owners_view_collaborators":false,"collections":[{"id":"","type":""}],"description":"","folder_upload_email":"","is_collaboration_restricted_to_enterprise":false,"name":"","parent":{"id":""},"shared_link":"","sync_state":"","tags":[]}'
};
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}}/folders/:folder_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "can_non_owners_invite": false,\n "can_non_owners_view_collaborators": false,\n "collections": [\n {\n "id": "",\n "type": ""\n }\n ],\n "description": "",\n "folder_upload_email": "",\n "is_collaboration_restricted_to_enterprise": false,\n "name": "",\n "parent": {\n "id": ""\n },\n "shared_link": "",\n "sync_state": "",\n "tags": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.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/folders/:folder_id',
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({
can_non_owners_invite: false,
can_non_owners_view_collaborators: false,
collections: [{id: '', type: ''}],
description: '',
folder_upload_email: '',
is_collaboration_restricted_to_enterprise: false,
name: '',
parent: {id: ''},
shared_link: '',
sync_state: '',
tags: []
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id',
headers: {'content-type': 'application/json'},
body: {
can_non_owners_invite: false,
can_non_owners_view_collaborators: false,
collections: [{id: '', type: ''}],
description: '',
folder_upload_email: '',
is_collaboration_restricted_to_enterprise: false,
name: '',
parent: {id: ''},
shared_link: '',
sync_state: '',
tags: []
},
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}}/folders/:folder_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
can_non_owners_invite: false,
can_non_owners_view_collaborators: false,
collections: [
{
id: '',
type: ''
}
],
description: '',
folder_upload_email: '',
is_collaboration_restricted_to_enterprise: false,
name: '',
parent: {
id: ''
},
shared_link: '',
sync_state: '',
tags: []
});
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}}/folders/:folder_id',
headers: {'content-type': 'application/json'},
data: {
can_non_owners_invite: false,
can_non_owners_view_collaborators: false,
collections: [{id: '', type: ''}],
description: '',
folder_upload_email: '',
is_collaboration_restricted_to_enterprise: false,
name: '',
parent: {id: ''},
shared_link: '',
sync_state: '',
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"can_non_owners_invite":false,"can_non_owners_view_collaborators":false,"collections":[{"id":"","type":""}],"description":"","folder_upload_email":"","is_collaboration_restricted_to_enterprise":false,"name":"","parent":{"id":""},"shared_link":"","sync_state":"","tags":[]}'
};
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 = @{ @"can_non_owners_invite": @NO,
@"can_non_owners_view_collaborators": @NO,
@"collections": @[ @{ @"id": @"", @"type": @"" } ],
@"description": @"",
@"folder_upload_email": @"",
@"is_collaboration_restricted_to_enterprise": @NO,
@"name": @"",
@"parent": @{ @"id": @"" },
@"shared_link": @"",
@"sync_state": @"",
@"tags": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_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}}/folders/:folder_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_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([
'can_non_owners_invite' => null,
'can_non_owners_view_collaborators' => null,
'collections' => [
[
'id' => '',
'type' => ''
]
],
'description' => '',
'folder_upload_email' => '',
'is_collaboration_restricted_to_enterprise' => null,
'name' => '',
'parent' => [
'id' => ''
],
'shared_link' => '',
'sync_state' => '',
'tags' => [
]
]),
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}}/folders/:folder_id', [
'body' => '{
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": {
"id": ""
},
"shared_link": "",
"sync_state": "",
"tags": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'can_non_owners_invite' => null,
'can_non_owners_view_collaborators' => null,
'collections' => [
[
'id' => '',
'type' => ''
]
],
'description' => '',
'folder_upload_email' => '',
'is_collaboration_restricted_to_enterprise' => null,
'name' => '',
'parent' => [
'id' => ''
],
'shared_link' => '',
'sync_state' => '',
'tags' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'can_non_owners_invite' => null,
'can_non_owners_view_collaborators' => null,
'collections' => [
[
'id' => '',
'type' => ''
]
],
'description' => '',
'folder_upload_email' => '',
'is_collaboration_restricted_to_enterprise' => null,
'name' => '',
'parent' => [
'id' => ''
],
'shared_link' => '',
'sync_state' => '',
'tags' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id');
$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}}/folders/:folder_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": {
"id": ""
},
"shared_link": "",
"sync_state": "",
"tags": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": {
"id": ""
},
"shared_link": "",
"sync_state": "",
"tags": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/folders/:folder_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id"
payload = {
"can_non_owners_invite": False,
"can_non_owners_view_collaborators": False,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": False,
"name": "",
"parent": { "id": "" },
"shared_link": "",
"sync_state": "",
"tags": []
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id"
payload <- "{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\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}}/folders/:folder_id")
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 \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\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/folders/:folder_id') do |req|
req.body = "{\n \"can_non_owners_invite\": false,\n \"can_non_owners_view_collaborators\": false,\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"folder_upload_email\": \"\",\n \"is_collaboration_restricted_to_enterprise\": false,\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": \"\",\n \"sync_state\": \"\",\n \"tags\": []\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}}/folders/:folder_id";
let payload = json!({
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": (
json!({
"id": "",
"type": ""
})
),
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": json!({"id": ""}),
"shared_link": "",
"sync_state": "",
"tags": ()
});
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}}/folders/:folder_id \
--header 'content-type: application/json' \
--data '{
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": {
"id": ""
},
"shared_link": "",
"sync_state": "",
"tags": []
}'
echo '{
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
{
"id": "",
"type": ""
}
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": {
"id": ""
},
"shared_link": "",
"sync_state": "",
"tags": []
}' | \
http PUT {{baseUrl}}/folders/:folder_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "can_non_owners_invite": false,\n "can_non_owners_view_collaborators": false,\n "collections": [\n {\n "id": "",\n "type": ""\n }\n ],\n "description": "",\n "folder_upload_email": "",\n "is_collaboration_restricted_to_enterprise": false,\n "name": "",\n "parent": {\n "id": ""\n },\n "shared_link": "",\n "sync_state": "",\n "tags": []\n}' \
--output-document \
- {{baseUrl}}/folders/:folder_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"can_non_owners_invite": false,
"can_non_owners_view_collaborators": false,
"collections": [
[
"id": "",
"type": ""
]
],
"description": "",
"folder_upload_email": "",
"is_collaboration_restricted_to_enterprise": false,
"name": "",
"parent": ["id": ""],
"shared_link": "",
"sync_state": "",
"tags": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Add user to group
{{baseUrl}}/group_memberships
BODY json
{
"configurable_permissions": {},
"group": {
"id": ""
},
"role": "",
"user": {
"id": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/group_memberships");
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 \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/group_memberships" {:content-type :json
:form-params {:configurable_permissions {}
:group {:id ""}
:role ""
:user {:id ""}}})
require "http/client"
url = "{{baseUrl}}/group_memberships"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\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}}/group_memberships"),
Content = new StringContent("{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\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}}/group_memberships");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/group_memberships"
payload := strings.NewReader("{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/group_memberships HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 111
{
"configurable_permissions": {},
"group": {
"id": ""
},
"role": "",
"user": {
"id": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/group_memberships")
.setHeader("content-type", "application/json")
.setBody("{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/group_memberships"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\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 \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/group_memberships")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/group_memberships")
.header("content-type", "application/json")
.body("{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
configurable_permissions: {},
group: {
id: ''
},
role: '',
user: {
id: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/group_memberships');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/group_memberships',
headers: {'content-type': 'application/json'},
data: {configurable_permissions: {}, group: {id: ''}, role: '', user: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/group_memberships';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"configurable_permissions":{},"group":{"id":""},"role":"","user":{"id":""}}'
};
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}}/group_memberships',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "configurable_permissions": {},\n "group": {\n "id": ""\n },\n "role": "",\n "user": {\n "id": ""\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 \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/group_memberships")
.post(body)
.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/group_memberships',
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({configurable_permissions: {}, group: {id: ''}, role: '', user: {id: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/group_memberships',
headers: {'content-type': 'application/json'},
body: {configurable_permissions: {}, group: {id: ''}, role: '', user: {id: ''}},
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}}/group_memberships');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
configurable_permissions: {},
group: {
id: ''
},
role: '',
user: {
id: ''
}
});
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}}/group_memberships',
headers: {'content-type': 'application/json'},
data: {configurable_permissions: {}, group: {id: ''}, role: '', user: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/group_memberships';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"configurable_permissions":{},"group":{"id":""},"role":"","user":{"id":""}}'
};
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 = @{ @"configurable_permissions": @{ },
@"group": @{ @"id": @"" },
@"role": @"",
@"user": @{ @"id": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/group_memberships"]
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}}/group_memberships" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/group_memberships",
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([
'configurable_permissions' => [
],
'group' => [
'id' => ''
],
'role' => '',
'user' => [
'id' => ''
]
]),
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('POST', '{{baseUrl}}/group_memberships', [
'body' => '{
"configurable_permissions": {},
"group": {
"id": ""
},
"role": "",
"user": {
"id": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/group_memberships');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'configurable_permissions' => [
],
'group' => [
'id' => ''
],
'role' => '',
'user' => [
'id' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'configurable_permissions' => [
],
'group' => [
'id' => ''
],
'role' => '',
'user' => [
'id' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/group_memberships');
$request->setRequestMethod('POST');
$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}}/group_memberships' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"configurable_permissions": {},
"group": {
"id": ""
},
"role": "",
"user": {
"id": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/group_memberships' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"configurable_permissions": {},
"group": {
"id": ""
},
"role": "",
"user": {
"id": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/group_memberships", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/group_memberships"
payload = {
"configurable_permissions": {},
"group": { "id": "" },
"role": "",
"user": { "id": "" }
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/group_memberships"
payload <- "{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\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}}/group_memberships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\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/group_memberships') do |req|
req.body = "{\n \"configurable_permissions\": {},\n \"group\": {\n \"id\": \"\"\n },\n \"role\": \"\",\n \"user\": {\n \"id\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/group_memberships";
let payload = json!({
"configurable_permissions": json!({}),
"group": json!({"id": ""}),
"role": "",
"user": json!({"id": ""})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/group_memberships \
--header 'content-type: application/json' \
--data '{
"configurable_permissions": {},
"group": {
"id": ""
},
"role": "",
"user": {
"id": ""
}
}'
echo '{
"configurable_permissions": {},
"group": {
"id": ""
},
"role": "",
"user": {
"id": ""
}
}' | \
http POST {{baseUrl}}/group_memberships \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "configurable_permissions": {},\n "group": {\n "id": ""\n },\n "role": "",\n "user": {\n "id": ""\n }\n}' \
--output-document \
- {{baseUrl}}/group_memberships
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"configurable_permissions": [],
"group": ["id": ""],
"role": "",
"user": ["id": ""]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/group_memberships")! 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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "member",
"type": "group_membership"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get group membership
{{baseUrl}}/group_memberships/:group_membership_id
QUERY PARAMS
group_membership_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/group_memberships/:group_membership_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/group_memberships/:group_membership_id")
require "http/client"
url = "{{baseUrl}}/group_memberships/:group_membership_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/group_memberships/:group_membership_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/group_memberships/:group_membership_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/group_memberships/:group_membership_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/group_memberships/:group_membership_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/group_memberships/:group_membership_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/group_memberships/:group_membership_id"))
.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}}/group_memberships/:group_membership_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/group_memberships/:group_membership_id")
.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}}/group_memberships/:group_membership_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/group_memberships/:group_membership_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/group_memberships/:group_membership_id';
const options = {method: 'GET'};
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}}/group_memberships/:group_membership_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/group_memberships/:group_membership_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/group_memberships/:group_membership_id',
headers: {}
};
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}}/group_memberships/:group_membership_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/group_memberships/:group_membership_id');
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}}/group_memberships/:group_membership_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/group_memberships/:group_membership_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/group_memberships/:group_membership_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/group_memberships/:group_membership_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/group_memberships/:group_membership_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/group_memberships/:group_membership_id');
echo $response->getBody();
setUrl('{{baseUrl}}/group_memberships/:group_membership_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/group_memberships/:group_membership_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/group_memberships/:group_membership_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/group_memberships/:group_membership_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/group_memberships/:group_membership_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/group_memberships/:group_membership_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/group_memberships/:group_membership_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/group_memberships/:group_membership_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/group_memberships/:group_membership_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/group_memberships/:group_membership_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/group_memberships/:group_membership_id
http GET {{baseUrl}}/group_memberships/:group_membership_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/group_memberships/:group_membership_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/group_memberships/:group_membership_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "member",
"type": "group_membership"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List members of group
{{baseUrl}}/groups/:group_id/memberships
QUERY PARAMS
group_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups/:group_id/memberships");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/groups/:group_id/memberships")
require "http/client"
url = "{{baseUrl}}/groups/:group_id/memberships"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/groups/:group_id/memberships"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/groups/:group_id/memberships");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups/:group_id/memberships"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/groups/:group_id/memberships HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/groups/:group_id/memberships")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups/:group_id/memberships"))
.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}}/groups/:group_id/memberships")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/groups/:group_id/memberships")
.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}}/groups/:group_id/memberships');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/groups/:group_id/memberships'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups/:group_id/memberships';
const options = {method: 'GET'};
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}}/groups/:group_id/memberships',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/groups/:group_id/memberships")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/groups/:group_id/memberships',
headers: {}
};
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}}/groups/:group_id/memberships'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/groups/:group_id/memberships');
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}}/groups/:group_id/memberships'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups/:group_id/memberships';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups/:group_id/memberships"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/groups/:group_id/memberships" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups/:group_id/memberships",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/groups/:group_id/memberships');
echo $response->getBody();
setUrl('{{baseUrl}}/groups/:group_id/memberships');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/groups/:group_id/memberships');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/groups/:group_id/memberships' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups/:group_id/memberships' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/groups/:group_id/memberships")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups/:group_id/memberships"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups/:group_id/memberships"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/groups/:group_id/memberships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/groups/:group_id/memberships') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/groups/:group_id/memberships";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/groups/:group_id/memberships
http GET {{baseUrl}}/groups/:group_id/memberships
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/groups/:group_id/memberships
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups/:group_id/memberships")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List user's groups
{{baseUrl}}/users/:user_id/memberships
QUERY PARAMS
user_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/memberships");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:user_id/memberships")
require "http/client"
url = "{{baseUrl}}/users/:user_id/memberships"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:user_id/memberships"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id/memberships");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/memberships"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/:user_id/memberships HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:user_id/memberships")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/memberships"))
.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}}/users/:user_id/memberships")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/:user_id/memberships")
.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}}/users/:user_id/memberships');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:user_id/memberships'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/memberships';
const options = {method: 'GET'};
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}}/users/:user_id/memberships',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/memberships")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id/memberships',
headers: {}
};
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}}/users/:user_id/memberships'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:user_id/memberships');
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}}/users/:user_id/memberships'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id/memberships';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/memberships"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/:user_id/memberships" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/memberships",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/users/:user_id/memberships');
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/memberships');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/:user_id/memberships');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id/memberships' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/memberships' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:user_id/memberships")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/memberships"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/memberships"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id/memberships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:user_id/memberships') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id/memberships";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:user_id/memberships
http GET {{baseUrl}}/users/:user_id/memberships
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:user_id/memberships
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/memberships")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove user from group
{{baseUrl}}/group_memberships/:group_membership_id
QUERY PARAMS
group_membership_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/group_memberships/:group_membership_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/group_memberships/:group_membership_id")
require "http/client"
url = "{{baseUrl}}/group_memberships/:group_membership_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/group_memberships/:group_membership_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/group_memberships/:group_membership_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/group_memberships/:group_membership_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/group_memberships/:group_membership_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/group_memberships/:group_membership_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/group_memberships/:group_membership_id"))
.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}}/group_memberships/:group_membership_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/group_memberships/:group_membership_id")
.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}}/group_memberships/:group_membership_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/group_memberships/:group_membership_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/group_memberships/:group_membership_id';
const options = {method: 'DELETE'};
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}}/group_memberships/:group_membership_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/group_memberships/:group_membership_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/group_memberships/:group_membership_id',
headers: {}
};
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}}/group_memberships/:group_membership_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/group_memberships/:group_membership_id');
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}}/group_memberships/:group_membership_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/group_memberships/:group_membership_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/group_memberships/:group_membership_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/group_memberships/:group_membership_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/group_memberships/:group_membership_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/group_memberships/:group_membership_id');
echo $response->getBody();
setUrl('{{baseUrl}}/group_memberships/:group_membership_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/group_memberships/:group_membership_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/group_memberships/:group_membership_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/group_memberships/:group_membership_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/group_memberships/:group_membership_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/group_memberships/:group_membership_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/group_memberships/:group_membership_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/group_memberships/:group_membership_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/group_memberships/:group_membership_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/group_memberships/:group_membership_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/group_memberships/:group_membership_id
http DELETE {{baseUrl}}/group_memberships/:group_membership_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/group_memberships/:group_membership_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/group_memberships/:group_membership_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update group membership
{{baseUrl}}/group_memberships/:group_membership_id
QUERY PARAMS
group_membership_id
BODY json
{
"configurable_permissions": {},
"role": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/group_memberships/:group_membership_id");
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 \"configurable_permissions\": {},\n \"role\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/group_memberships/:group_membership_id" {:content-type :json
:form-params {:configurable_permissions {}
:role ""}})
require "http/client"
url = "{{baseUrl}}/group_memberships/:group_membership_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"configurable_permissions\": {},\n \"role\": \"\"\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}}/group_memberships/:group_membership_id"),
Content = new StringContent("{\n \"configurable_permissions\": {},\n \"role\": \"\"\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}}/group_memberships/:group_membership_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"configurable_permissions\": {},\n \"role\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/group_memberships/:group_membership_id"
payload := strings.NewReader("{\n \"configurable_permissions\": {},\n \"role\": \"\"\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/group_memberships/:group_membership_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 50
{
"configurable_permissions": {},
"role": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/group_memberships/:group_membership_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"configurable_permissions\": {},\n \"role\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/group_memberships/:group_membership_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"configurable_permissions\": {},\n \"role\": \"\"\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 \"configurable_permissions\": {},\n \"role\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/group_memberships/:group_membership_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/group_memberships/:group_membership_id")
.header("content-type", "application/json")
.body("{\n \"configurable_permissions\": {},\n \"role\": \"\"\n}")
.asString();
const data = JSON.stringify({
configurable_permissions: {},
role: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/group_memberships/:group_membership_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/group_memberships/:group_membership_id',
headers: {'content-type': 'application/json'},
data: {configurable_permissions: {}, role: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/group_memberships/:group_membership_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"configurable_permissions":{},"role":""}'
};
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}}/group_memberships/:group_membership_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "configurable_permissions": {},\n "role": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"configurable_permissions\": {},\n \"role\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/group_memberships/:group_membership_id")
.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/group_memberships/:group_membership_id',
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({configurable_permissions: {}, role: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/group_memberships/:group_membership_id',
headers: {'content-type': 'application/json'},
body: {configurable_permissions: {}, role: ''},
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}}/group_memberships/:group_membership_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
configurable_permissions: {},
role: ''
});
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}}/group_memberships/:group_membership_id',
headers: {'content-type': 'application/json'},
data: {configurable_permissions: {}, role: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/group_memberships/:group_membership_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"configurable_permissions":{},"role":""}'
};
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 = @{ @"configurable_permissions": @{ },
@"role": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/group_memberships/:group_membership_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}}/group_memberships/:group_membership_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"configurable_permissions\": {},\n \"role\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/group_memberships/:group_membership_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([
'configurable_permissions' => [
],
'role' => ''
]),
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}}/group_memberships/:group_membership_id', [
'body' => '{
"configurable_permissions": {},
"role": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/group_memberships/:group_membership_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'configurable_permissions' => [
],
'role' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'configurable_permissions' => [
],
'role' => ''
]));
$request->setRequestUrl('{{baseUrl}}/group_memberships/:group_membership_id');
$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}}/group_memberships/:group_membership_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"configurable_permissions": {},
"role": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/group_memberships/:group_membership_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"configurable_permissions": {},
"role": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"configurable_permissions\": {},\n \"role\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/group_memberships/:group_membership_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/group_memberships/:group_membership_id"
payload = {
"configurable_permissions": {},
"role": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/group_memberships/:group_membership_id"
payload <- "{\n \"configurable_permissions\": {},\n \"role\": \"\"\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}}/group_memberships/:group_membership_id")
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 \"configurable_permissions\": {},\n \"role\": \"\"\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/group_memberships/:group_membership_id') do |req|
req.body = "{\n \"configurable_permissions\": {},\n \"role\": \"\"\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}}/group_memberships/:group_membership_id";
let payload = json!({
"configurable_permissions": json!({}),
"role": ""
});
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}}/group_memberships/:group_membership_id \
--header 'content-type: application/json' \
--data '{
"configurable_permissions": {},
"role": ""
}'
echo '{
"configurable_permissions": {},
"role": ""
}' | \
http PUT {{baseUrl}}/group_memberships/:group_membership_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "configurable_permissions": {},\n "role": ""\n}' \
--output-document \
- {{baseUrl}}/group_memberships/:group_membership_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"configurable_permissions": [],
"role": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/group_memberships/:group_membership_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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "member",
"type": "group_membership"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create group
{{baseUrl}}/groups
BODY json
{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups");
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 \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/groups" {:content-type :json
:form-params {:description ""
:external_sync_identifier ""
:invitability_level ""
:member_viewability_level ""
:name ""
:provenance ""}})
require "http/client"
url = "{{baseUrl}}/groups"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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}}/groups"),
Content = new StringContent("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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}}/groups");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups"
payload := strings.NewReader("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/groups HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 153
{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/groups")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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 \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/groups")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/groups")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/groups');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/groups',
headers: {'content-type': 'application/json'},
data: {
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","external_sync_identifier":"","invitability_level":"","member_viewability_level":"","name":"","provenance":""}'
};
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}}/groups',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "external_sync_identifier": "",\n "invitability_level": "",\n "member_viewability_level": "",\n "name": "",\n "provenance": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/groups")
.post(body)
.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/groups',
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({
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/groups',
headers: {'content-type': 'application/json'},
body: {
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
},
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}}/groups');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
});
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}}/groups',
headers: {'content-type': 'application/json'},
data: {
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","external_sync_identifier":"","invitability_level":"","member_viewability_level":"","name":"","provenance":""}'
};
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 = @{ @"description": @"",
@"external_sync_identifier": @"",
@"invitability_level": @"",
@"member_viewability_level": @"",
@"name": @"",
@"provenance": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups"]
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}}/groups" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups",
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([
'description' => '',
'external_sync_identifier' => '',
'invitability_level' => '',
'member_viewability_level' => '',
'name' => '',
'provenance' => ''
]),
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('POST', '{{baseUrl}}/groups', [
'body' => '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/groups');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'external_sync_identifier' => '',
'invitability_level' => '',
'member_viewability_level' => '',
'name' => '',
'provenance' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'external_sync_identifier' => '',
'invitability_level' => '',
'member_viewability_level' => '',
'name' => '',
'provenance' => ''
]));
$request->setRequestUrl('{{baseUrl}}/groups');
$request->setRequestMethod('POST');
$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}}/groups' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/groups", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups"
payload = {
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups"
payload <- "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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}}/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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/groups') do |req|
req.body = "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/groups";
let payload = json!({
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/groups \
--header 'content-type: application/json' \
--data '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}'
echo '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}' | \
http POST {{baseUrl}}/groups \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "external_sync_identifier": "",\n "invitability_level": "",\n "member_viewability_level": "",\n "name": "",\n "provenance": ""\n}' \
--output-document \
- {{baseUrl}}/groups
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create jobs to terminate user group session
{{baseUrl}}/groups/terminate_sessions
BODY json
{
"group_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups/terminate_sessions");
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 \"group_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/groups/terminate_sessions" {:content-type :json
:form-params {:group_ids []}})
require "http/client"
url = "{{baseUrl}}/groups/terminate_sessions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"group_ids\": []\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}}/groups/terminate_sessions"),
Content = new StringContent("{\n \"group_ids\": []\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}}/groups/terminate_sessions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"group_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups/terminate_sessions"
payload := strings.NewReader("{\n \"group_ids\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/groups/terminate_sessions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 21
{
"group_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/groups/terminate_sessions")
.setHeader("content-type", "application/json")
.setBody("{\n \"group_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups/terminate_sessions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"group_ids\": []\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 \"group_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/groups/terminate_sessions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/groups/terminate_sessions")
.header("content-type", "application/json")
.body("{\n \"group_ids\": []\n}")
.asString();
const data = JSON.stringify({
group_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/groups/terminate_sessions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/groups/terminate_sessions',
headers: {'content-type': 'application/json'},
data: {group_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups/terminate_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"group_ids":[]}'
};
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}}/groups/terminate_sessions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "group_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"group_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/groups/terminate_sessions")
.post(body)
.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/groups/terminate_sessions',
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({group_ids: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/groups/terminate_sessions',
headers: {'content-type': 'application/json'},
body: {group_ids: []},
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}}/groups/terminate_sessions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
group_ids: []
});
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}}/groups/terminate_sessions',
headers: {'content-type': 'application/json'},
data: {group_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups/terminate_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"group_ids":[]}'
};
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 = @{ @"group_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups/terminate_sessions"]
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}}/groups/terminate_sessions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"group_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups/terminate_sessions",
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([
'group_ids' => [
]
]),
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('POST', '{{baseUrl}}/groups/terminate_sessions', [
'body' => '{
"group_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/groups/terminate_sessions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'group_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'group_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/groups/terminate_sessions');
$request->setRequestMethod('POST');
$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}}/groups/terminate_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"group_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups/terminate_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"group_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"group_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/groups/terminate_sessions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups/terminate_sessions"
payload = { "group_ids": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups/terminate_sessions"
payload <- "{\n \"group_ids\": []\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}}/groups/terminate_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"group_ids\": []\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/groups/terminate_sessions') do |req|
req.body = "{\n \"group_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/groups/terminate_sessions";
let payload = json!({"group_ids": ()});
let mut headers = reqwest::header::HeaderMap::new();
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}}/groups/terminate_sessions \
--header 'content-type: application/json' \
--data '{
"group_ids": []
}'
echo '{
"group_ids": []
}' | \
http POST {{baseUrl}}/groups/terminate_sessions \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "group_ids": []\n}' \
--output-document \
- {{baseUrl}}/groups/terminate_sessions
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["group_ids": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups/terminate_sessions")! 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
{
"message": "Request is successful, please check the admin events for the status of the job"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get group
{{baseUrl}}/groups/:group_id
QUERY PARAMS
group_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups/:group_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/groups/:group_id")
require "http/client"
url = "{{baseUrl}}/groups/:group_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/groups/:group_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/groups/:group_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups/:group_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/groups/:group_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/groups/:group_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups/:group_id"))
.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}}/groups/:group_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/groups/:group_id")
.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}}/groups/:group_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/groups/:group_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups/:group_id';
const options = {method: 'GET'};
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}}/groups/:group_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/groups/:group_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/groups/:group_id',
headers: {}
};
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}}/groups/:group_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/groups/:group_id');
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}}/groups/:group_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups/:group_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups/:group_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/groups/:group_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups/:group_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/groups/:group_id');
echo $response->getBody();
setUrl('{{baseUrl}}/groups/:group_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/groups/:group_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/groups/:group_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups/:group_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/groups/:group_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups/:group_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups/:group_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/groups/:group_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/groups/:group_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/groups/:group_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/groups/:group_id
http GET {{baseUrl}}/groups/:group_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/groups/:group_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups/:group_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List groups for enterprise
{{baseUrl}}/groups
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/groups")
require "http/client"
url = "{{baseUrl}}/groups"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/groups"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/groups");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/groups HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/groups")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups"))
.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}}/groups")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/groups")
.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}}/groups');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups';
const options = {method: 'GET'};
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}}/groups',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/groups")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/groups',
headers: {}
};
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}}/groups'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/groups');
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}}/groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/groups" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/groups');
echo $response->getBody();
setUrl('{{baseUrl}}/groups');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/groups');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/groups' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/groups")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/groups') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/groups";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/groups
http GET {{baseUrl}}/groups
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/groups
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove group
{{baseUrl}}/groups/:group_id
QUERY PARAMS
group_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups/:group_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/groups/:group_id")
require "http/client"
url = "{{baseUrl}}/groups/:group_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/groups/:group_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/groups/:group_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups/:group_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/groups/:group_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/groups/:group_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups/:group_id"))
.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}}/groups/:group_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/groups/:group_id")
.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}}/groups/:group_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/groups/:group_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups/:group_id';
const options = {method: 'DELETE'};
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}}/groups/:group_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/groups/:group_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/groups/:group_id',
headers: {}
};
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}}/groups/:group_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/groups/:group_id');
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}}/groups/:group_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups/:group_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups/:group_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/groups/:group_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups/:group_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/groups/:group_id');
echo $response->getBody();
setUrl('{{baseUrl}}/groups/:group_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/groups/:group_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/groups/:group_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups/:group_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/groups/:group_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups/:group_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups/:group_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/groups/:group_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/groups/:group_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/groups/:group_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/groups/:group_id
http DELETE {{baseUrl}}/groups/:group_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/groups/:group_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups/:group_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update group
{{baseUrl}}/groups/:group_id
QUERY PARAMS
group_id
BODY json
{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/groups/:group_id");
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 \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/groups/:group_id" {:content-type :json
:form-params {:description ""
:external_sync_identifier ""
:invitability_level ""
:member_viewability_level ""
:name ""
:provenance ""}})
require "http/client"
url = "{{baseUrl}}/groups/:group_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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}}/groups/:group_id"),
Content = new StringContent("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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}}/groups/:group_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/groups/:group_id"
payload := strings.NewReader("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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/groups/:group_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 153
{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/groups/:group_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/groups/:group_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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 \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/groups/:group_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/groups/:group_id")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/groups/:group_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/groups/:group_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/groups/:group_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","external_sync_identifier":"","invitability_level":"","member_viewability_level":"","name":"","provenance":""}'
};
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}}/groups/:group_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "external_sync_identifier": "",\n "invitability_level": "",\n "member_viewability_level": "",\n "name": "",\n "provenance": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/groups/:group_id")
.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/groups/:group_id',
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({
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/groups/:group_id',
headers: {'content-type': 'application/json'},
body: {
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
},
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}}/groups/:group_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
});
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}}/groups/:group_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
external_sync_identifier: '',
invitability_level: '',
member_viewability_level: '',
name: '',
provenance: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/groups/:group_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","external_sync_identifier":"","invitability_level":"","member_viewability_level":"","name":"","provenance":""}'
};
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 = @{ @"description": @"",
@"external_sync_identifier": @"",
@"invitability_level": @"",
@"member_viewability_level": @"",
@"name": @"",
@"provenance": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/groups/:group_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}}/groups/:group_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/groups/:group_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([
'description' => '',
'external_sync_identifier' => '',
'invitability_level' => '',
'member_viewability_level' => '',
'name' => '',
'provenance' => ''
]),
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}}/groups/:group_id', [
'body' => '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/groups/:group_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'external_sync_identifier' => '',
'invitability_level' => '',
'member_viewability_level' => '',
'name' => '',
'provenance' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'external_sync_identifier' => '',
'invitability_level' => '',
'member_viewability_level' => '',
'name' => '',
'provenance' => ''
]));
$request->setRequestUrl('{{baseUrl}}/groups/:group_id');
$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}}/groups/:group_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/groups/:group_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/groups/:group_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/groups/:group_id"
payload = {
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/groups/:group_id"
payload <- "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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}}/groups/:group_id")
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 \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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/groups/:group_id') do |req|
req.body = "{\n \"description\": \"\",\n \"external_sync_identifier\": \"\",\n \"invitability_level\": \"\",\n \"member_viewability_level\": \"\",\n \"name\": \"\",\n \"provenance\": \"\"\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}}/groups/:group_id";
let payload = json!({
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
});
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}}/groups/:group_id \
--header 'content-type: application/json' \
--data '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}'
echo '{
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
}' | \
http PUT {{baseUrl}}/groups/:group_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "external_sync_identifier": "",\n "invitability_level": "",\n "member_viewability_level": "",\n "name": "",\n "provenance": ""\n}' \
--output-document \
- {{baseUrl}}/groups/:group_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"external_sync_identifier": "",
"invitability_level": "",
"member_viewability_level": "",
"name": "",
"provenance": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/groups/:group_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create user invite
{{baseUrl}}/invites
BODY json
{
"actionable_by": {
"login": ""
},
"enterprise": {
"id": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/invites");
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 \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/invites" {:content-type :json
:form-params {:actionable_by {:login ""}
:enterprise {:id ""}}})
require "http/client"
url = "{{baseUrl}}/invites"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\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}}/invites"),
Content = new StringContent("{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\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}}/invites");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/invites"
payload := strings.NewReader("{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/invites HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 80
{
"actionable_by": {
"login": ""
},
"enterprise": {
"id": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/invites")
.setHeader("content-type", "application/json")
.setBody("{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/invites"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\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 \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/invites")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/invites")
.header("content-type", "application/json")
.body("{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
actionable_by: {
login: ''
},
enterprise: {
id: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/invites');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/invites',
headers: {'content-type': 'application/json'},
data: {actionable_by: {login: ''}, enterprise: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/invites';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"actionable_by":{"login":""},"enterprise":{"id":""}}'
};
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}}/invites',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "actionable_by": {\n "login": ""\n },\n "enterprise": {\n "id": ""\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 \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/invites")
.post(body)
.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/invites',
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({actionable_by: {login: ''}, enterprise: {id: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/invites',
headers: {'content-type': 'application/json'},
body: {actionable_by: {login: ''}, enterprise: {id: ''}},
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}}/invites');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
actionable_by: {
login: ''
},
enterprise: {
id: ''
}
});
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}}/invites',
headers: {'content-type': 'application/json'},
data: {actionable_by: {login: ''}, enterprise: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/invites';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"actionable_by":{"login":""},"enterprise":{"id":""}}'
};
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 = @{ @"actionable_by": @{ @"login": @"" },
@"enterprise": @{ @"id": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/invites"]
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}}/invites" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/invites",
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([
'actionable_by' => [
'login' => ''
],
'enterprise' => [
'id' => ''
]
]),
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('POST', '{{baseUrl}}/invites', [
'body' => '{
"actionable_by": {
"login": ""
},
"enterprise": {
"id": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/invites');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'actionable_by' => [
'login' => ''
],
'enterprise' => [
'id' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'actionable_by' => [
'login' => ''
],
'enterprise' => [
'id' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/invites');
$request->setRequestMethod('POST');
$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}}/invites' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"actionable_by": {
"login": ""
},
"enterprise": {
"id": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/invites' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"actionable_by": {
"login": ""
},
"enterprise": {
"id": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/invites", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/invites"
payload = {
"actionable_by": { "login": "" },
"enterprise": { "id": "" }
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/invites"
payload <- "{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\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}}/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\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/invites') do |req|
req.body = "{\n \"actionable_by\": {\n \"login\": \"\"\n },\n \"enterprise\": {\n \"id\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/invites";
let payload = json!({
"actionable_by": json!({"login": ""}),
"enterprise": json!({"id": ""})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/invites \
--header 'content-type: application/json' \
--data '{
"actionable_by": {
"login": ""
},
"enterprise": {
"id": ""
}
}'
echo '{
"actionable_by": {
"login": ""
},
"enterprise": {
"id": ""
}
}' | \
http POST {{baseUrl}}/invites \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "actionable_by": {\n "login": ""\n },\n "enterprise": {\n "id": ""\n }\n}' \
--output-document \
- {{baseUrl}}/invites
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"actionable_by": ["login": ""],
"enterprise": ["id": ""]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/invites")! 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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"invited_to": {
"id": "11446498",
"name": "Acme Inc.",
"type": "enterprise"
},
"modified_at": "2012-12-12T10:53:43-08:00",
"status": "pending",
"type": "invite"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get user invite status
{{baseUrl}}/invites/:invite_id
QUERY PARAMS
invite_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/invites/:invite_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/invites/:invite_id")
require "http/client"
url = "{{baseUrl}}/invites/:invite_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/invites/:invite_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/invites/:invite_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/invites/:invite_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/invites/:invite_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/invites/:invite_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/invites/:invite_id"))
.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}}/invites/:invite_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/invites/:invite_id")
.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}}/invites/:invite_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/invites/:invite_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/invites/:invite_id';
const options = {method: 'GET'};
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}}/invites/:invite_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/invites/:invite_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/invites/:invite_id',
headers: {}
};
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}}/invites/:invite_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/invites/:invite_id');
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}}/invites/:invite_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/invites/:invite_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/invites/:invite_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/invites/:invite_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/invites/:invite_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/invites/:invite_id');
echo $response->getBody();
setUrl('{{baseUrl}}/invites/:invite_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/invites/:invite_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/invites/:invite_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/invites/:invite_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/invites/:invite_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/invites/:invite_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/invites/:invite_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/invites/:invite_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/invites/:invite_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/invites/:invite_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/invites/:invite_id
http GET {{baseUrl}}/invites/:invite_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/invites/:invite_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/invites/:invite_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"invited_to": {
"id": "11446498",
"name": "Acme Inc.",
"type": "enterprise"
},
"modified_at": "2012-12-12T10:53:43-08:00",
"status": "pending",
"type": "invite"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create legal hold policy
{{baseUrl}}/legal_hold_policies
BODY json
{
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policies");
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 \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/legal_hold_policies" {:content-type :json
:form-params {:description ""
:filter_ended_at ""
:filter_started_at ""
:is_ongoing false
:policy_name ""}})
require "http/client"
url = "{{baseUrl}}/legal_hold_policies"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\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}}/legal_hold_policies"),
Content = new StringContent("{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\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}}/legal_hold_policies");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policies"
payload := strings.NewReader("{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/legal_hold_policies HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 119
{
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/legal_hold_policies")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policies"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\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 \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/legal_hold_policies")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/legal_hold_policies")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
filter_ended_at: '',
filter_started_at: '',
is_ongoing: false,
policy_name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/legal_hold_policies');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/legal_hold_policies',
headers: {'content-type': 'application/json'},
data: {
description: '',
filter_ended_at: '',
filter_started_at: '',
is_ongoing: false,
policy_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policies';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","filter_ended_at":"","filter_started_at":"","is_ongoing":false,"policy_name":""}'
};
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}}/legal_hold_policies',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "filter_ended_at": "",\n "filter_started_at": "",\n "is_ongoing": false,\n "policy_name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policies")
.post(body)
.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/legal_hold_policies',
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({
description: '',
filter_ended_at: '',
filter_started_at: '',
is_ongoing: false,
policy_name: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/legal_hold_policies',
headers: {'content-type': 'application/json'},
body: {
description: '',
filter_ended_at: '',
filter_started_at: '',
is_ongoing: false,
policy_name: ''
},
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}}/legal_hold_policies');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
filter_ended_at: '',
filter_started_at: '',
is_ongoing: false,
policy_name: ''
});
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}}/legal_hold_policies',
headers: {'content-type': 'application/json'},
data: {
description: '',
filter_ended_at: '',
filter_started_at: '',
is_ongoing: false,
policy_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policies';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","filter_ended_at":"","filter_started_at":"","is_ongoing":false,"policy_name":""}'
};
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 = @{ @"description": @"",
@"filter_ended_at": @"",
@"filter_started_at": @"",
@"is_ongoing": @NO,
@"policy_name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policies"]
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}}/legal_hold_policies" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policies",
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([
'description' => '',
'filter_ended_at' => '',
'filter_started_at' => '',
'is_ongoing' => null,
'policy_name' => ''
]),
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('POST', '{{baseUrl}}/legal_hold_policies', [
'body' => '{
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policies');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'filter_ended_at' => '',
'filter_started_at' => '',
'is_ongoing' => null,
'policy_name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'filter_ended_at' => '',
'filter_started_at' => '',
'is_ongoing' => null,
'policy_name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/legal_hold_policies');
$request->setRequestMethod('POST');
$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}}/legal_hold_policies' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policies' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/legal_hold_policies", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policies"
payload = {
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": False,
"policy_name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policies"
payload <- "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\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}}/legal_hold_policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\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/legal_hold_policies') do |req|
req.body = "{\n \"description\": \"\",\n \"filter_ended_at\": \"\",\n \"filter_started_at\": \"\",\n \"is_ongoing\": false,\n \"policy_name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policies";
let payload = json!({
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/legal_hold_policies \
--header 'content-type: application/json' \
--data '{
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
}'
echo '{
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
}' | \
http POST {{baseUrl}}/legal_hold_policies \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "filter_ended_at": "",\n "filter_started_at": "",\n "is_ongoing": false,\n "policy_name": ""\n}' \
--output-document \
- {{baseUrl}}/legal_hold_policies
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"filter_ended_at": "",
"filter_started_at": "",
"is_ongoing": false,
"policy_name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policies")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get legal hold policy
{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
QUERY PARAMS
legal_hold_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
require "http/client"
url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/legal_hold_policies/:legal_hold_policy_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"))
.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}}/legal_hold_policies/:legal_hold_policy_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.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}}/legal_hold_policies/:legal_hold_policy_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id';
const options = {method: 'GET'};
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}}/legal_hold_policies/:legal_hold_policy_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policies/:legal_hold_policy_id',
headers: {}
};
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}}/legal_hold_policies/:legal_hold_policy_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
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}}/legal_hold_policies/:legal_hold_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/legal_hold_policies/:legal_hold_policy_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/legal_hold_policies/:legal_hold_policy_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/legal_hold_policies/:legal_hold_policy_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
http GET {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List all legal hold policies
{{baseUrl}}/legal_hold_policies
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policies");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/legal_hold_policies")
require "http/client"
url = "{{baseUrl}}/legal_hold_policies"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policies"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policies");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policies"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/legal_hold_policies HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/legal_hold_policies")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policies"))
.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}}/legal_hold_policies")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/legal_hold_policies")
.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}}/legal_hold_policies');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/legal_hold_policies'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policies';
const options = {method: 'GET'};
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}}/legal_hold_policies',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policies")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policies',
headers: {}
};
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}}/legal_hold_policies'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/legal_hold_policies');
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}}/legal_hold_policies'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policies';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policies"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/legal_hold_policies" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/legal_hold_policies');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policies');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policies');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policies' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policies' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/legal_hold_policies")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policies"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policies"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/legal_hold_policies') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policies";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/legal_hold_policies
http GET {{baseUrl}}/legal_hold_policies
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/legal_hold_policies
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policies")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove legal hold policy
{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
QUERY PARAMS
legal_hold_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
require "http/client"
url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/legal_hold_policies/:legal_hold_policy_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"))
.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}}/legal_hold_policies/:legal_hold_policy_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.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}}/legal_hold_policies/:legal_hold_policy_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id';
const options = {method: 'DELETE'};
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}}/legal_hold_policies/:legal_hold_policy_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policies/:legal_hold_policy_id',
headers: {}
};
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}}/legal_hold_policies/:legal_hold_policy_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
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}}/legal_hold_policies/:legal_hold_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/legal_hold_policies/:legal_hold_policy_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/legal_hold_policies/:legal_hold_policy_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/legal_hold_policies/:legal_hold_policy_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
http DELETE {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update legal hold policy
{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
QUERY PARAMS
legal_hold_policy_id
BODY json
{
"description": "",
"policy_name": "",
"release_notes": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id");
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 \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id" {:content-type :json
:form-params {:description ""
:policy_name ""
:release_notes ""}})
require "http/client"
url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\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}}/legal_hold_policies/:legal_hold_policy_id"),
Content = new StringContent("{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\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}}/legal_hold_policies/:legal_hold_policy_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
payload := strings.NewReader("{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\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/legal_hold_policies/:legal_hold_policy_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 67
{
"description": "",
"policy_name": "",
"release_notes": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\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 \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
policy_name: '',
release_notes: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id',
headers: {'content-type': 'application/json'},
data: {description: '', policy_name: '', release_notes: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","policy_name":"","release_notes":""}'
};
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}}/legal_hold_policies/:legal_hold_policy_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "policy_name": "",\n "release_notes": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id")
.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/legal_hold_policies/:legal_hold_policy_id',
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({description: '', policy_name: '', release_notes: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id',
headers: {'content-type': 'application/json'},
body: {description: '', policy_name: '', release_notes: ''},
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}}/legal_hold_policies/:legal_hold_policy_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
policy_name: '',
release_notes: ''
});
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}}/legal_hold_policies/:legal_hold_policy_id',
headers: {'content-type': 'application/json'},
data: {description: '', policy_name: '', release_notes: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","policy_name":"","release_notes":""}'
};
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 = @{ @"description": @"",
@"policy_name": @"",
@"release_notes": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policies/:legal_hold_policy_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}}/legal_hold_policies/:legal_hold_policy_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policies/:legal_hold_policy_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([
'description' => '',
'policy_name' => '',
'release_notes' => ''
]),
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}}/legal_hold_policies/:legal_hold_policy_id', [
'body' => '{
"description": "",
"policy_name": "",
"release_notes": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'policy_name' => '',
'release_notes' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'policy_name' => '',
'release_notes' => ''
]));
$request->setRequestUrl('{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id');
$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}}/legal_hold_policies/:legal_hold_policy_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"policy_name": "",
"release_notes": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"policy_name": "",
"release_notes": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/legal_hold_policies/:legal_hold_policy_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
payload = {
"description": "",
"policy_name": "",
"release_notes": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_id"
payload <- "{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\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}}/legal_hold_policies/:legal_hold_policy_id")
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 \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\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/legal_hold_policies/:legal_hold_policy_id') do |req|
req.body = "{\n \"description\": \"\",\n \"policy_name\": \"\",\n \"release_notes\": \"\"\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}}/legal_hold_policies/:legal_hold_policy_id";
let payload = json!({
"description": "",
"policy_name": "",
"release_notes": ""
});
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}}/legal_hold_policies/:legal_hold_policy_id \
--header 'content-type: application/json' \
--data '{
"description": "",
"policy_name": "",
"release_notes": ""
}'
echo '{
"description": "",
"policy_name": "",
"release_notes": ""
}' | \
http PUT {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "policy_name": "",\n "release_notes": ""\n}' \
--output-document \
- {{baseUrl}}/legal_hold_policies/:legal_hold_policy_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"policy_name": "",
"release_notes": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policies/:legal_hold_policy_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Assign legal hold policy
{{baseUrl}}/legal_hold_policy_assignments
BODY json
{
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policy_assignments");
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 \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/legal_hold_policy_assignments" {:content-type :json
:form-params {:assign_to {:id ""
:type ""}
:policy_id ""}})
require "http/client"
url = "{{baseUrl}}/legal_hold_policy_assignments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\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}}/legal_hold_policy_assignments"),
Content = new StringContent("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\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}}/legal_hold_policy_assignments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policy_assignments"
payload := strings.NewReader("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/legal_hold_policy_assignments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 72
{
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/legal_hold_policy_assignments")
.setHeader("content-type", "application/json")
.setBody("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policy_assignments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\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 \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/legal_hold_policy_assignments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/legal_hold_policy_assignments")
.header("content-type", "application/json")
.body("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
assign_to: {
id: '',
type: ''
},
policy_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/legal_hold_policy_assignments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/legal_hold_policy_assignments',
headers: {'content-type': 'application/json'},
data: {assign_to: {id: '', type: ''}, policy_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policy_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assign_to":{"id":"","type":""},"policy_id":""}'
};
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}}/legal_hold_policy_assignments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "assign_to": {\n "id": "",\n "type": ""\n },\n "policy_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policy_assignments")
.post(body)
.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/legal_hold_policy_assignments',
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({assign_to: {id: '', type: ''}, policy_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/legal_hold_policy_assignments',
headers: {'content-type': 'application/json'},
body: {assign_to: {id: '', type: ''}, policy_id: ''},
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}}/legal_hold_policy_assignments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
assign_to: {
id: '',
type: ''
},
policy_id: ''
});
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}}/legal_hold_policy_assignments',
headers: {'content-type': 'application/json'},
data: {assign_to: {id: '', type: ''}, policy_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policy_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assign_to":{"id":"","type":""},"policy_id":""}'
};
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 = @{ @"assign_to": @{ @"id": @"", @"type": @"" },
@"policy_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policy_assignments"]
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}}/legal_hold_policy_assignments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policy_assignments",
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([
'assign_to' => [
'id' => '',
'type' => ''
],
'policy_id' => ''
]),
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('POST', '{{baseUrl}}/legal_hold_policy_assignments', [
'body' => '{
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policy_assignments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'assign_to' => [
'id' => '',
'type' => ''
],
'policy_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'assign_to' => [
'id' => '',
'type' => ''
],
'policy_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/legal_hold_policy_assignments');
$request->setRequestMethod('POST');
$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}}/legal_hold_policy_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policy_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/legal_hold_policy_assignments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policy_assignments"
payload = {
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policy_assignments"
payload <- "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\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}}/legal_hold_policy_assignments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\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/legal_hold_policy_assignments') do |req|
req.body = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"policy_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policy_assignments";
let payload = json!({
"assign_to": json!({
"id": "",
"type": ""
}),
"policy_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/legal_hold_policy_assignments \
--header 'content-type: application/json' \
--data '{
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}'
echo '{
"assign_to": {
"id": "",
"type": ""
},
"policy_id": ""
}' | \
http POST {{baseUrl}}/legal_hold_policy_assignments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "assign_to": {\n "id": "",\n "type": ""\n },\n "policy_id": ""\n}' \
--output-document \
- {{baseUrl}}/legal_hold_policy_assignments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"assign_to": [
"id": "",
"type": ""
],
"policy_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policy_assignments")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get legal hold policy assignment
{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
QUERY PARAMS
legal_hold_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
require "http/client"
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"))
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id';
const options = {method: 'GET'};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id',
headers: {}
};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
http GET {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List current file versions for legal hold policy assignment
{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold
QUERY PARAMS
legal_hold_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")
require "http/client"
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold"))
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold';
const options = {method: 'GET'};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold',
headers: {}
};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold');
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold
http GET {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List legal hold policy assignments
{{baseUrl}}/legal_hold_policy_assignments
QUERY PARAMS
policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policy_assignments?policy_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/legal_hold_policy_assignments" {:query-params {:policy_id ""}})
require "http/client"
url = "{{baseUrl}}/legal_hold_policy_assignments?policy_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policy_assignments?policy_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policy_assignments?policy_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policy_assignments?policy_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/legal_hold_policy_assignments?policy_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/legal_hold_policy_assignments?policy_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policy_assignments?policy_id="))
.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}}/legal_hold_policy_assignments?policy_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/legal_hold_policy_assignments?policy_id=")
.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}}/legal_hold_policy_assignments?policy_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/legal_hold_policy_assignments',
params: {policy_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policy_assignments?policy_id=';
const options = {method: 'GET'};
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}}/legal_hold_policy_assignments?policy_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policy_assignments?policy_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policy_assignments?policy_id=',
headers: {}
};
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}}/legal_hold_policy_assignments',
qs: {policy_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/legal_hold_policy_assignments');
req.query({
policy_id: ''
});
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}}/legal_hold_policy_assignments',
params: {policy_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policy_assignments?policy_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policy_assignments?policy_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/legal_hold_policy_assignments?policy_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policy_assignments?policy_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/legal_hold_policy_assignments?policy_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policy_assignments');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'policy_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policy_assignments');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'policy_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policy_assignments?policy_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policy_assignments?policy_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/legal_hold_policy_assignments?policy_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policy_assignments"
querystring = {"policy_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policy_assignments"
queryString <- list(policy_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policy_assignments?policy_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/legal_hold_policy_assignments') do |req|
req.params['policy_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policy_assignments";
let querystring = [
("policy_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/legal_hold_policy_assignments?policy_id='
http GET '{{baseUrl}}/legal_hold_policy_assignments?policy_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/legal_hold_policy_assignments?policy_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policy_assignments?policy_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List previous file versions for legal hold policy assignment
{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold
QUERY PARAMS
legal_hold_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")
require "http/client"
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold"))
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold';
const options = {method: 'GET'};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold',
headers: {}
};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold');
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold
http GET {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Unassign legal hold policy
{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
QUERY PARAMS
legal_hold_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
require "http/client"
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"))
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id';
const options = {method: 'DELETE'};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id',
headers: {}
};
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/legal_hold_policy_assignments/:legal_hold_policy_assignment_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
http DELETE {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/legal_hold_policy_assignments/:legal_hold_policy_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create metadata cascade policy
{{baseUrl}}/metadata_cascade_policies
BODY json
{
"folder_id": "",
"scope": "",
"templateKey": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_cascade_policies");
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 \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata_cascade_policies" {:content-type :json
:form-params {:folder_id ""
:scope ""
:templateKey ""}})
require "http/client"
url = "{{baseUrl}}/metadata_cascade_policies"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_cascade_policies"),
Content = new StringContent("{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_cascade_policies");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_cascade_policies"
payload := strings.NewReader("{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/metadata_cascade_policies HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 57
{
"folder_id": "",
"scope": "",
"templateKey": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata_cascade_policies")
.setHeader("content-type", "application/json")
.setBody("{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_cascade_policies"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\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 \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata_cascade_policies")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata_cascade_policies")
.header("content-type", "application/json")
.body("{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
.asString();
const data = JSON.stringify({
folder_id: '',
scope: '',
templateKey: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata_cascade_policies');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_cascade_policies',
headers: {'content-type': 'application/json'},
data: {folder_id: '', scope: '', templateKey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_cascade_policies';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder_id":"","scope":"","templateKey":""}'
};
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}}/metadata_cascade_policies',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "folder_id": "",\n "scope": "",\n "templateKey": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata_cascade_policies")
.post(body)
.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/metadata_cascade_policies',
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({folder_id: '', scope: '', templateKey: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_cascade_policies',
headers: {'content-type': 'application/json'},
body: {folder_id: '', scope: '', templateKey: ''},
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}}/metadata_cascade_policies');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
folder_id: '',
scope: '',
templateKey: ''
});
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}}/metadata_cascade_policies',
headers: {'content-type': 'application/json'},
data: {folder_id: '', scope: '', templateKey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_cascade_policies';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder_id":"","scope":"","templateKey":""}'
};
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 = @{ @"folder_id": @"",
@"scope": @"",
@"templateKey": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_cascade_policies"]
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}}/metadata_cascade_policies" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_cascade_policies",
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([
'folder_id' => '',
'scope' => '',
'templateKey' => ''
]),
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('POST', '{{baseUrl}}/metadata_cascade_policies', [
'body' => '{
"folder_id": "",
"scope": "",
"templateKey": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_cascade_policies');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'folder_id' => '',
'scope' => '',
'templateKey' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'folder_id' => '',
'scope' => '',
'templateKey' => ''
]));
$request->setRequestUrl('{{baseUrl}}/metadata_cascade_policies');
$request->setRequestMethod('POST');
$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}}/metadata_cascade_policies' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder_id": "",
"scope": "",
"templateKey": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_cascade_policies' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder_id": "",
"scope": "",
"templateKey": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata_cascade_policies", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_cascade_policies"
payload = {
"folder_id": "",
"scope": "",
"templateKey": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_cascade_policies"
payload <- "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_cascade_policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\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/metadata_cascade_policies') do |req|
req.body = "{\n \"folder_id\": \"\",\n \"scope\": \"\",\n \"templateKey\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_cascade_policies";
let payload = json!({
"folder_id": "",
"scope": "",
"templateKey": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/metadata_cascade_policies \
--header 'content-type: application/json' \
--data '{
"folder_id": "",
"scope": "",
"templateKey": ""
}'
echo '{
"folder_id": "",
"scope": "",
"templateKey": ""
}' | \
http POST {{baseUrl}}/metadata_cascade_policies \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "folder_id": "",\n "scope": "",\n "templateKey": ""\n}' \
--output-document \
- {{baseUrl}}/metadata_cascade_policies
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"folder_id": "",
"scope": "",
"templateKey": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_cascade_policies")! 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
{
"id": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"owner_enterprise": {
"id": "690678",
"type": "enterprise"
},
"parent": {
"id": "1234567",
"type": "folder"
},
"scope": "global",
"templateKey": "productInfo",
"type": "metadata_cascade_policy"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Force-apply metadata cascade policy to folder
{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply
QUERY PARAMS
metadata_cascade_policy_id
BODY json
{
"conflict_resolution": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply");
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 \"conflict_resolution\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply" {:content-type :json
:form-params {:conflict_resolution ""}})
require "http/client"
url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"conflict_resolution\": \"\"\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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply"),
Content = new StringContent("{\n \"conflict_resolution\": \"\"\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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"conflict_resolution\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply"
payload := strings.NewReader("{\n \"conflict_resolution\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id/apply HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 31
{
"conflict_resolution": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply")
.setHeader("content-type", "application/json")
.setBody("{\n \"conflict_resolution\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"conflict_resolution\": \"\"\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 \"conflict_resolution\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply")
.header("content-type", "application/json")
.body("{\n \"conflict_resolution\": \"\"\n}")
.asString();
const data = JSON.stringify({
conflict_resolution: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply',
headers: {'content-type': 'application/json'},
data: {conflict_resolution: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"conflict_resolution":""}'
};
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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "conflict_resolution": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"conflict_resolution\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply")
.post(body)
.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/metadata_cascade_policies/:metadata_cascade_policy_id/apply',
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({conflict_resolution: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply',
headers: {'content-type': 'application/json'},
body: {conflict_resolution: ''},
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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
conflict_resolution: ''
});
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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply',
headers: {'content-type': 'application/json'},
data: {conflict_resolution: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"conflict_resolution":""}'
};
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 = @{ @"conflict_resolution": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply"]
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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"conflict_resolution\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply",
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([
'conflict_resolution' => ''
]),
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('POST', '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply', [
'body' => '{
"conflict_resolution": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'conflict_resolution' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'conflict_resolution' => ''
]));
$request->setRequestUrl('{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply');
$request->setRequestMethod('POST');
$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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"conflict_resolution": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"conflict_resolution": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"conflict_resolution\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id/apply", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply"
payload = { "conflict_resolution": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply"
payload <- "{\n \"conflict_resolution\": \"\"\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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"conflict_resolution\": \"\"\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/metadata_cascade_policies/:metadata_cascade_policy_id/apply') do |req|
req.body = "{\n \"conflict_resolution\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply";
let payload = json!({"conflict_resolution": ""});
let mut headers = reqwest::header::HeaderMap::new();
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}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply \
--header 'content-type: application/json' \
--data '{
"conflict_resolution": ""
}'
echo '{
"conflict_resolution": ""
}' | \
http POST {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "conflict_resolution": ""\n}' \
--output-document \
- {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["conflict_resolution": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id/apply")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get metadata cascade policy
{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
QUERY PARAMS
metadata_cascade_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
require "http/client"
url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"))
.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}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.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}}/metadata_cascade_policies/:metadata_cascade_policy_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id';
const options = {method: 'GET'};
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}}/metadata_cascade_policies/:metadata_cascade_policy_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id',
headers: {}
};
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}}/metadata_cascade_policies/:metadata_cascade_policy_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
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}}/metadata_cascade_policies/:metadata_cascade_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_cascade_policies/:metadata_cascade_policy_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
http GET {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"id": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"owner_enterprise": {
"id": "690678",
"type": "enterprise"
},
"parent": {
"id": "1234567",
"type": "folder"
},
"scope": "global",
"templateKey": "productInfo",
"type": "metadata_cascade_policy"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List metadata cascade policies
{{baseUrl}}/metadata_cascade_policies
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_cascade_policies?folder_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_cascade_policies" {:query-params {:folder_id ""}})
require "http/client"
url = "{{baseUrl}}/metadata_cascade_policies?folder_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_cascade_policies?folder_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_cascade_policies?folder_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_cascade_policies?folder_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_cascade_policies?folder_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_cascade_policies?folder_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_cascade_policies?folder_id="))
.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}}/metadata_cascade_policies?folder_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_cascade_policies?folder_id=")
.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}}/metadata_cascade_policies?folder_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_cascade_policies',
params: {folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_cascade_policies?folder_id=';
const options = {method: 'GET'};
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}}/metadata_cascade_policies?folder_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_cascade_policies?folder_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_cascade_policies?folder_id=',
headers: {}
};
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}}/metadata_cascade_policies',
qs: {folder_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_cascade_policies');
req.query({
folder_id: ''
});
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}}/metadata_cascade_policies',
params: {folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_cascade_policies?folder_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_cascade_policies?folder_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_cascade_policies?folder_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_cascade_policies?folder_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_cascade_policies?folder_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_cascade_policies');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'folder_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_cascade_policies');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'folder_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_cascade_policies?folder_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_cascade_policies?folder_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_cascade_policies?folder_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_cascade_policies"
querystring = {"folder_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_cascade_policies"
queryString <- list(folder_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_cascade_policies?folder_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_cascade_policies') do |req|
req.params['folder_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_cascade_policies";
let querystring = [
("folder_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/metadata_cascade_policies?folder_id='
http GET '{{baseUrl}}/metadata_cascade_policies?folder_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/metadata_cascade_policies?folder_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_cascade_policies?folder_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove metadata cascade policy
{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
QUERY PARAMS
metadata_cascade_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
require "http/client"
url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"))
.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}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.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}}/metadata_cascade_policies/:metadata_cascade_policy_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id';
const options = {method: 'DELETE'};
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}}/metadata_cascade_policies/:metadata_cascade_policy_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id',
headers: {}
};
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}}/metadata_cascade_policies/:metadata_cascade_policy_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
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}}/metadata_cascade_policies/:metadata_cascade_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/metadata_cascade_policies/:metadata_cascade_policy_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/metadata_cascade_policies/:metadata_cascade_policy_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
http DELETE {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_cascade_policies/:metadata_cascade_policy_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create metadata instance on file
{{baseUrl}}/files/:file_id/metadata/:scope/:template_key
QUERY PARAMS
file_id
scope
template_key
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
headers = HTTP::Headers{
"content-type" => "application/json"
}
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}}/files/:file_id/metadata/:scope/:template_key"),
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}}/files/:file_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Post);
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}}/files/:file_id/metadata/:scope/:template_key"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id/metadata/:scope/:template_key HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"))
.header("content-type", "application/json")
.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}}/files/:file_id/metadata/:scope/:template_key")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.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('POST', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'POST', headers: {'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}}/files/:file_id/metadata/:scope/:template_key',
method: 'POST',
headers: {
'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}}/files/:file_id/metadata/:scope/:template_key")
.post(body)
.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/files/:file_id/metadata/:scope/:template_key',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key',
headers: {'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('POST', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
req.headers({
'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: 'POST',
url: '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key',
headers: {'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}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'POST', headers: {'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 = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"]
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}}/files/:file_id/metadata/:scope/:template_key" in
let headers = Header.add (Header.init ()) "content-type" "application/json" 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}}/files/:file_id/metadata/:scope/:template_key",
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 => [
"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}}/files/:file_id/metadata/:scope/:template_key', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'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}}/files/:file_id/metadata/:scope/:template_key');
$request->setRequestMethod('POST');
$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}}/files/:file_id/metadata/:scope/:template_key' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/:file_id/metadata/:scope/:template_key", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
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}}/files/:file_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
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/files/:file_id/metadata/:scope/:template_key') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/:file_id/metadata/:scope/:template_key \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/files/:file_id/metadata/:scope/:template_key \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get metadata instance on file
{{baseUrl}}/files/:file_id/metadata/:scope/:template_key
QUERY PARAMS
file_id
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/metadata/:scope/:template_key HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"))
.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}}/files/:file_id/metadata/:scope/:template_key")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.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}}/files/:file_id/metadata/:scope/:template_key');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'GET'};
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}}/files/:file_id/metadata/:scope/:template_key',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/:scope/:template_key',
headers: {}
};
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}}/files/:file_id/metadata/:scope/:template_key'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
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}}/files/:file_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/metadata/:scope/:template_key" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/:scope/:template_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/metadata/:scope/:template_key")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/metadata/:scope/:template_key') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
http GET {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List metadata instances on file
{{baseUrl}}/files/:file_id/metadata
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/metadata")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/metadata HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/metadata")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata"))
.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}}/files/:file_id/metadata")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/metadata")
.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}}/files/:file_id/metadata');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/files/:file_id/metadata'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata';
const options = {method: 'GET'};
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}}/files/:file_id/metadata',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata',
headers: {}
};
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}}/files/:file_id/metadata'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/metadata');
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}}/files/:file_id/metadata'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/metadata" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/metadata');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/metadata")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/metadata') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/metadata
http GET {{baseUrl}}/files/:file_id/metadata
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/metadata
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 100
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove metadata instance from file
{{baseUrl}}/files/:file_id/metadata/:scope/:template_key
QUERY PARAMS
file_id
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/:file_id/metadata/:scope/:template_key HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"))
.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}}/files/:file_id/metadata/:scope/:template_key")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.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}}/files/:file_id/metadata/:scope/:template_key');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'DELETE'};
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}}/files/:file_id/metadata/:scope/:template_key',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/:scope/:template_key',
headers: {}
};
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}}/files/:file_id/metadata/:scope/:template_key'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
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}}/files/:file_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/:file_id/metadata/:scope/:template_key" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/:scope/:template_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/:file_id/metadata/:scope/:template_key")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/:file_id/metadata/:scope/:template_key') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
http DELETE {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update metadata instance on file
{{baseUrl}}/files/:file_id/metadata/:scope/:template_key
QUERY PARAMS
file_id
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/files/:file_id/metadata/:scope/:template_key HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"))
.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}}/files/:file_id/metadata/:scope/:template_key")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.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}}/files/:file_id/metadata/:scope/:template_key');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'PUT'};
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}}/files/:file_id/metadata/:scope/:template_key',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/:scope/:template_key',
headers: {}
};
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}}/files/:file_id/metadata/:scope/:template_key'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
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}}/files/:file_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/files/:file_id/metadata/:scope/:template_key" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/:scope/:template_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/:scope/:template_key');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/:scope/:template_key' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/files/:file_id/metadata/:scope/:template_key")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/files/:file_id/metadata/:scope/:template_key') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
http PUT {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/:scope/:template_key
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create metadata instance on folder
{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
QUERY PARAMS
folder_id
scope
template_key
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
headers = HTTP::Headers{
"content-type" => "application/json"
}
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}}/folders/:folder_id/metadata/:scope/:template_key"),
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}}/folders/:folder_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Post);
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}}/folders/:folder_id/metadata/:scope/:template_key"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/folders/:folder_id/metadata/:scope/:template_key HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"))
.header("content-type", "application/json")
.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}}/folders/:folder_id/metadata/:scope/:template_key")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.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('POST', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'POST', headers: {'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}}/folders/:folder_id/metadata/:scope/:template_key',
method: 'POST',
headers: {
'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}}/folders/:folder_id/metadata/:scope/:template_key")
.post(body)
.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/folders/:folder_id/metadata/:scope/:template_key',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key',
headers: {'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('POST', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
req.headers({
'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: 'POST',
url: '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key',
headers: {'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}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'POST', headers: {'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 = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"]
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}}/folders/:folder_id/metadata/:scope/:template_key" in
let headers = Header.add (Header.init ()) "content-type" "application/json" 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}}/folders/:folder_id/metadata/:scope/:template_key",
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 => [
"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}}/folders/:folder_id/metadata/:scope/:template_key', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'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}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setRequestMethod('POST');
$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}}/folders/:folder_id/metadata/:scope/:template_key' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders/:folder_id/metadata/:scope/:template_key", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
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}}/folders/:folder_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{}"
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/folders/:folder_id/metadata/:scope/:template_key') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key";
let payload = json!({});
let mut headers = reqwest::header::HeaderMap::new();
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}}/folders/:folder_id/metadata/:scope/:template_key \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get metadata instance on folder
{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
QUERY PARAMS
folder_id
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id/metadata/:scope/:template_key HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"))
.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}}/folders/:folder_id/metadata/:scope/:template_key")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.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}}/folders/:folder_id/metadata/:scope/:template_key');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'GET'};
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}}/folders/:folder_id/metadata/:scope/:template_key',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/metadata/:scope/:template_key',
headers: {}
};
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}}/folders/:folder_id/metadata/:scope/:template_key'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
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}}/folders/:folder_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id/metadata/:scope/:template_key" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id/metadata/:scope/:template_key")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id/metadata/:scope/:template_key') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
http GET {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List metadata instances on folder
{{baseUrl}}/folders/:folder_id/metadata
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id/metadata")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/metadata"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/metadata");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id/metadata HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id/metadata")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata"))
.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}}/folders/:folder_id/metadata")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id/metadata")
.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}}/folders/:folder_id/metadata');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/folders/:folder_id/metadata'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata';
const options = {method: 'GET'};
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}}/folders/:folder_id/metadata',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/metadata',
headers: {}
};
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}}/folders/:folder_id/metadata'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id/metadata');
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}}/folders/:folder_id/metadata'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id/metadata" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id/metadata');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/metadata' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id/metadata")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id/metadata') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id/metadata
http GET {{baseUrl}}/folders/:folder_id/metadata
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 100
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove metadata instance from folder
{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
QUERY PARAMS
folder_id
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/folders/:folder_id/metadata/:scope/:template_key HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"))
.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}}/folders/:folder_id/metadata/:scope/:template_key")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.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}}/folders/:folder_id/metadata/:scope/:template_key');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'DELETE'};
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}}/folders/:folder_id/metadata/:scope/:template_key',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/metadata/:scope/:template_key',
headers: {}
};
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}}/folders/:folder_id/metadata/:scope/:template_key'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
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}}/folders/:folder_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/folders/:folder_id/metadata/:scope/:template_key" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/folders/:folder_id/metadata/:scope/:template_key")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/folders/:folder_id/metadata/:scope/:template_key') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
http DELETE {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update metadata instance on folder
{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
QUERY PARAMS
folder_id
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/folders/:folder_id/metadata/:scope/:template_key HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"))
.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}}/folders/:folder_id/metadata/:scope/:template_key")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.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}}/folders/:folder_id/metadata/:scope/:template_key');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'PUT'};
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}}/folders/:folder_id/metadata/:scope/:template_key',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/metadata/:scope/:template_key',
headers: {}
};
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}}/folders/:folder_id/metadata/:scope/:template_key'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
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}}/folders/:folder_id/metadata/:scope/:template_key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/folders/:folder_id/metadata/:scope/:template_key" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/folders/:folder_id/metadata/:scope/:template_key")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/folders/:folder_id/metadata/:scope/:template_key') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
http PUT {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create metadata template
{{baseUrl}}/metadata_templates/schema
BODY json
{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": ""
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/schema");
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 \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata_templates/schema" {:content-type :json
:form-params {:copyInstanceOnItemCopy false
:displayName ""
:fields [{:description ""
:displayName ""
:hidden false
:key ""
:options [{:key ""}]
:type ""}]
:hidden false
:scope ""
:templateKey ""}})
require "http/client"
url = "{{baseUrl}}/metadata_templates/schema"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_templates/schema"),
Content = new StringContent("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_templates/schema");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/schema"
payload := strings.NewReader("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/metadata_templates/schema HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 319
{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": ""
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata_templates/schema")
.setHeader("content-type", "application/json")
.setBody("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/schema"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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 \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata_templates/schema")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata_templates/schema")
.header("content-type", "application/json")
.body("{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
.asString();
const data = JSON.stringify({
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
description: '',
displayName: '',
hidden: false,
key: '',
options: [
{
key: ''
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata_templates/schema');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_templates/schema',
headers: {'content-type': 'application/json'},
data: {
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
description: '',
displayName: '',
hidden: false,
key: '',
options: [{key: ''}],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/schema';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"copyInstanceOnItemCopy":false,"displayName":"","fields":[{"description":"","displayName":"","hidden":false,"key":"","options":[{"key":""}],"type":""}],"hidden":false,"scope":"","templateKey":""}'
};
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}}/metadata_templates/schema',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "copyInstanceOnItemCopy": false,\n "displayName": "",\n "fields": [\n {\n "description": "",\n "displayName": "",\n "hidden": false,\n "key": "",\n "options": [\n {\n "key": ""\n }\n ],\n "type": ""\n }\n ],\n "hidden": false,\n "scope": "",\n "templateKey": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/schema")
.post(body)
.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/metadata_templates/schema',
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({
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
description: '',
displayName: '',
hidden: false,
key: '',
options: [{key: ''}],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_templates/schema',
headers: {'content-type': 'application/json'},
body: {
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
description: '',
displayName: '',
hidden: false,
key: '',
options: [{key: ''}],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
},
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}}/metadata_templates/schema');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
description: '',
displayName: '',
hidden: false,
key: '',
options: [
{
key: ''
}
],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
});
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}}/metadata_templates/schema',
headers: {'content-type': 'application/json'},
data: {
copyInstanceOnItemCopy: false,
displayName: '',
fields: [
{
description: '',
displayName: '',
hidden: false,
key: '',
options: [{key: ''}],
type: ''
}
],
hidden: false,
scope: '',
templateKey: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/schema';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"copyInstanceOnItemCopy":false,"displayName":"","fields":[{"description":"","displayName":"","hidden":false,"key":"","options":[{"key":""}],"type":""}],"hidden":false,"scope":"","templateKey":""}'
};
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 = @{ @"copyInstanceOnItemCopy": @NO,
@"displayName": @"",
@"fields": @[ @{ @"description": @"", @"displayName": @"", @"hidden": @NO, @"key": @"", @"options": @[ @{ @"key": @"" } ], @"type": @"" } ],
@"hidden": @NO,
@"scope": @"",
@"templateKey": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/schema"]
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}}/metadata_templates/schema" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/schema",
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([
'copyInstanceOnItemCopy' => null,
'displayName' => '',
'fields' => [
[
'description' => '',
'displayName' => '',
'hidden' => null,
'key' => '',
'options' => [
[
'key' => ''
]
],
'type' => ''
]
],
'hidden' => null,
'scope' => '',
'templateKey' => ''
]),
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('POST', '{{baseUrl}}/metadata_templates/schema', [
'body' => '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": ""
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/schema');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'copyInstanceOnItemCopy' => null,
'displayName' => '',
'fields' => [
[
'description' => '',
'displayName' => '',
'hidden' => null,
'key' => '',
'options' => [
[
'key' => ''
]
],
'type' => ''
]
],
'hidden' => null,
'scope' => '',
'templateKey' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'copyInstanceOnItemCopy' => null,
'displayName' => '',
'fields' => [
[
'description' => '',
'displayName' => '',
'hidden' => null,
'key' => '',
'options' => [
[
'key' => ''
]
],
'type' => ''
]
],
'hidden' => null,
'scope' => '',
'templateKey' => ''
]));
$request->setRequestUrl('{{baseUrl}}/metadata_templates/schema');
$request->setRequestMethod('POST');
$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}}/metadata_templates/schema' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": ""
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/schema' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": ""
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata_templates/schema", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/schema"
payload = {
"copyInstanceOnItemCopy": False,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": False,
"key": "",
"options": [{ "key": "" }],
"type": ""
}
],
"hidden": False,
"scope": "",
"templateKey": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/schema"
payload <- "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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}}/metadata_templates/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\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/metadata_templates/schema') do |req|
req.body = "{\n \"copyInstanceOnItemCopy\": false,\n \"displayName\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"displayName\": \"\",\n \"hidden\": false,\n \"key\": \"\",\n \"options\": [\n {\n \"key\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"hidden\": false,\n \"scope\": \"\",\n \"templateKey\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/schema";
let payload = json!({
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": (
json!({
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": (json!({"key": ""})),
"type": ""
})
),
"hidden": false,
"scope": "",
"templateKey": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/metadata_templates/schema \
--header 'content-type: application/json' \
--data '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": ""
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}'
echo '{
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
{
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [
{
"key": ""
}
],
"type": ""
}
],
"hidden": false,
"scope": "",
"templateKey": ""
}' | \
http POST {{baseUrl}}/metadata_templates/schema \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "copyInstanceOnItemCopy": false,\n "displayName": "",\n "fields": [\n {\n "description": "",\n "displayName": "",\n "hidden": false,\n "key": "",\n "options": [\n {\n "key": ""\n }\n ],\n "type": ""\n }\n ],\n "hidden": false,\n "scope": "",\n "templateKey": ""\n}' \
--output-document \
- {{baseUrl}}/metadata_templates/schema
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"copyInstanceOnItemCopy": false,
"displayName": "",
"fields": [
[
"description": "",
"displayName": "",
"hidden": false,
"key": "",
"options": [["key": ""]],
"type": ""
]
],
"hidden": false,
"scope": "",
"templateKey": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/schema")! 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
{
"copyInstanceOnItemCopy": true,
"displayName": "Product Info",
"hidden": true,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Find metadata template by instance ID
{{baseUrl}}/metadata_templates
QUERY PARAMS
metadata_instance_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates?metadata_instance_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_templates" {:query-params {:metadata_instance_id ""}})
require "http/client"
url = "{{baseUrl}}/metadata_templates?metadata_instance_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_templates?metadata_instance_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates?metadata_instance_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates?metadata_instance_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_templates?metadata_instance_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_templates?metadata_instance_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates?metadata_instance_id="))
.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}}/metadata_templates?metadata_instance_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_templates?metadata_instance_id=")
.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}}/metadata_templates?metadata_instance_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_templates',
params: {metadata_instance_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates?metadata_instance_id=';
const options = {method: 'GET'};
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}}/metadata_templates?metadata_instance_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates?metadata_instance_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates?metadata_instance_id=',
headers: {}
};
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}}/metadata_templates',
qs: {metadata_instance_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_templates');
req.query({
metadata_instance_id: ''
});
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}}/metadata_templates',
params: {metadata_instance_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates?metadata_instance_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates?metadata_instance_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_templates?metadata_instance_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates?metadata_instance_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_templates?metadata_instance_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'metadata_instance_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'metadata_instance_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates?metadata_instance_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates?metadata_instance_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_templates?metadata_instance_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates"
querystring = {"metadata_instance_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates"
queryString <- list(metadata_instance_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates?metadata_instance_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_templates') do |req|
req.params['metadata_instance_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates";
let querystring = [
("metadata_instance_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/metadata_templates?metadata_instance_id='
http GET '{{baseUrl}}/metadata_templates?metadata_instance_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/metadata_templates?metadata_instance_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates?metadata_instance_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get metadata template by ID
{{baseUrl}}/metadata_templates/:template_id
QUERY PARAMS
template_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/:template_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_templates/:template_id")
require "http/client"
url = "{{baseUrl}}/metadata_templates/:template_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/:template_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/:template_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/:template_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_templates/:template_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_templates/:template_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/:template_id"))
.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}}/metadata_templates/:template_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_templates/:template_id")
.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}}/metadata_templates/:template_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_templates/:template_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/:template_id';
const options = {method: 'GET'};
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}}/metadata_templates/:template_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/:template_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/:template_id',
headers: {}
};
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}}/metadata_templates/:template_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_templates/:template_id');
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}}/metadata_templates/:template_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/:template_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/:template_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_templates/:template_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/:template_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_templates/:template_id');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/:template_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/:template_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/:template_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/:template_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_templates/:template_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/:template_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/:template_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/:template_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_templates/:template_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/:template_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata_templates/:template_id
http GET {{baseUrl}}/metadata_templates/:template_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata_templates/:template_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/:template_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"copyInstanceOnItemCopy": true,
"displayName": "Product Info",
"hidden": true,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"copyInstanceOnItemCopy": true,
"displayName": "Product Info",
"hidden": true,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get metadata template by name
{{baseUrl}}/metadata_templates/:scope/:template_key/schema
QUERY PARAMS
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/:scope/:template_key/schema");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
require "http/client"
url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/:scope/:template_key/schema"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/:scope/:template_key/schema");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_templates/:scope/:template_key/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/:scope/:template_key/schema"))
.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}}/metadata_templates/:scope/:template_key/schema")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.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}}/metadata_templates/:scope/:template_key/schema');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_templates/:scope/:template_key/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/:scope/:template_key/schema';
const options = {method: 'GET'};
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}}/metadata_templates/:scope/:template_key/schema',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/:scope/:template_key/schema',
headers: {}
};
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}}/metadata_templates/:scope/:template_key/schema'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
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}}/metadata_templates/:scope/:template_key/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/:scope/:template_key/schema';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/:scope/:template_key/schema"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_templates/:scope/:template_key/schema" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/:scope/:template_key/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/:scope/:template_key/schema' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/:scope/:template_key/schema' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_templates/:scope/:template_key/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_templates/:scope/:template_key/schema') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata_templates/:scope/:template_key/schema
http GET {{baseUrl}}/metadata_templates/:scope/:template_key/schema
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata_templates/:scope/:template_key/schema
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"copyInstanceOnItemCopy": true,
"displayName": "Product Info",
"hidden": true,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List all global metadata templates
{{baseUrl}}/metadata_templates/global
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/global");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_templates/global")
require "http/client"
url = "{{baseUrl}}/metadata_templates/global"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/global"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/global");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/global"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_templates/global HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_templates/global")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/global"))
.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}}/metadata_templates/global")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_templates/global")
.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}}/metadata_templates/global');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/metadata_templates/global'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/global';
const options = {method: 'GET'};
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}}/metadata_templates/global',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/global")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/global',
headers: {}
};
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}}/metadata_templates/global'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_templates/global');
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}}/metadata_templates/global'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/global';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/global"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_templates/global" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/global",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_templates/global');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/global');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/global');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/global' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/global' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_templates/global")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/global"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/global"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/global")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_templates/global') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/global";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata_templates/global
http GET {{baseUrl}}/metadata_templates/global
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata_templates/global
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/global")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List all metadata templates for enterprise
{{baseUrl}}/metadata_templates/enterprise
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/enterprise");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_templates/enterprise")
require "http/client"
url = "{{baseUrl}}/metadata_templates/enterprise"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/enterprise"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/enterprise");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/enterprise"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_templates/enterprise HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_templates/enterprise")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/enterprise"))
.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}}/metadata_templates/enterprise")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_templates/enterprise")
.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}}/metadata_templates/enterprise');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_templates/enterprise'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/enterprise';
const options = {method: 'GET'};
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}}/metadata_templates/enterprise',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/enterprise")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/enterprise',
headers: {}
};
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}}/metadata_templates/enterprise'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_templates/enterprise');
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}}/metadata_templates/enterprise'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/enterprise';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/enterprise"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_templates/enterprise" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/enterprise",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_templates/enterprise');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/enterprise');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/enterprise');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/enterprise' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/enterprise' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_templates/enterprise")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/enterprise"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/enterprise"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/enterprise")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_templates/enterprise') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/enterprise";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata_templates/enterprise
http GET {{baseUrl}}/metadata_templates/enterprise
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata_templates/enterprise
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/enterprise")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove metadata template
{{baseUrl}}/metadata_templates/:scope/:template_key/schema
QUERY PARAMS
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/:scope/:template_key/schema");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
require "http/client"
url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/:scope/:template_key/schema"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/:scope/:template_key/schema");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/metadata_templates/:scope/:template_key/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/:scope/:template_key/schema"))
.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}}/metadata_templates/:scope/:template_key/schema")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.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}}/metadata_templates/:scope/:template_key/schema');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/metadata_templates/:scope/:template_key/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/:scope/:template_key/schema';
const options = {method: 'DELETE'};
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}}/metadata_templates/:scope/:template_key/schema',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/:scope/:template_key/schema',
headers: {}
};
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}}/metadata_templates/:scope/:template_key/schema'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
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}}/metadata_templates/:scope/:template_key/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/:scope/:template_key/schema';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/:scope/:template_key/schema"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/metadata_templates/:scope/:template_key/schema" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/:scope/:template_key/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/:scope/:template_key/schema' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/:scope/:template_key/schema' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/metadata_templates/:scope/:template_key/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/metadata_templates/:scope/:template_key/schema') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/metadata_templates/:scope/:template_key/schema
http DELETE {{baseUrl}}/metadata_templates/:scope/:template_key/schema
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/metadata_templates/:scope/:template_key/schema
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update metadata template
{{baseUrl}}/metadata_templates/:scope/:template_key/schema
QUERY PARAMS
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_templates/:scope/:template_key/schema");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
require "http/client"
url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/metadata_templates/:scope/:template_key/schema"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_templates/:scope/:template_key/schema");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/metadata_templates/:scope/:template_key/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_templates/:scope/:template_key/schema"))
.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}}/metadata_templates/:scope/:template_key/schema")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.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}}/metadata_templates/:scope/:template_key/schema');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata_templates/:scope/:template_key/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_templates/:scope/:template_key/schema';
const options = {method: 'PUT'};
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}}/metadata_templates/:scope/:template_key/schema',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_templates/:scope/:template_key/schema',
headers: {}
};
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}}/metadata_templates/:scope/:template_key/schema'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
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}}/metadata_templates/:scope/:template_key/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_templates/:scope/:template_key/schema';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_templates/:scope/:template_key/schema"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/metadata_templates/:scope/:template_key/schema" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_templates/:scope/:template_key/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_templates/:scope/:template_key/schema');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_templates/:scope/:template_key/schema' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_templates/:scope/:template_key/schema' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/metadata_templates/:scope/:template_key/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_templates/:scope/:template_key/schema"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_templates/:scope/:template_key/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/metadata_templates/:scope/:template_key/schema') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_templates/:scope/:template_key/schema";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/metadata_templates/:scope/:template_key/schema
http PUT {{baseUrl}}/metadata_templates/:scope/:template_key/schema
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/metadata_templates/:scope/:template_key/schema
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_templates/:scope/:template_key/schema")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"copyInstanceOnItemCopy": true,
"displayName": "Product Info",
"hidden": true,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"type": "metadata_template"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List recently accessed items
{{baseUrl}}/recent_items
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/recent_items");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/recent_items")
require "http/client"
url = "{{baseUrl}}/recent_items"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/recent_items"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/recent_items");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/recent_items"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/recent_items HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/recent_items")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/recent_items"))
.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}}/recent_items")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/recent_items")
.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}}/recent_items');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/recent_items'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/recent_items';
const options = {method: 'GET'};
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}}/recent_items',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/recent_items")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/recent_items',
headers: {}
};
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}}/recent_items'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/recent_items');
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}}/recent_items'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/recent_items';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/recent_items"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/recent_items" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/recent_items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/recent_items');
echo $response->getBody();
setUrl('{{baseUrl}}/recent_items');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/recent_items');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/recent_items' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/recent_items' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/recent_items")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/recent_items"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/recent_items"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/recent_items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/recent_items') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/recent_items";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/recent_items
http GET {{baseUrl}}/recent_items
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/recent_items
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/recent_items")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create retention policy
{{baseUrl}}/retention_policies
BODY json
{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policies");
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 \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/retention_policies" {:content-type :json
:form-params {:are_owners_notified false
:can_owner_extend_retention false
:custom_notification_recipients [{}]
:description ""
:disposition_action ""
:policy_name ""
:policy_type ""
:retention_length ""
:retention_type ""}})
require "http/client"
url = "{{baseUrl}}/retention_policies"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\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}}/retention_policies"),
Content = new StringContent("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\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}}/retention_policies");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policies"
payload := strings.NewReader("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/retention_policies HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 264
{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/retention_policies")
.setHeader("content-type", "application/json")
.setBody("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policies"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\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 \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/retention_policies")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/retention_policies")
.header("content-type", "application/json")
.body("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}")
.asString();
const data = JSON.stringify({
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [
{}
],
description: '',
disposition_action: '',
policy_name: '',
policy_type: '',
retention_length: '',
retention_type: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/retention_policies');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/retention_policies',
headers: {'content-type': 'application/json'},
data: {
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
policy_type: '',
retention_length: '',
retention_type: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policies';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"are_owners_notified":false,"can_owner_extend_retention":false,"custom_notification_recipients":[{}],"description":"","disposition_action":"","policy_name":"","policy_type":"","retention_length":"","retention_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}}/retention_policies',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "are_owners_notified": false,\n "can_owner_extend_retention": false,\n "custom_notification_recipients": [\n {}\n ],\n "description": "",\n "disposition_action": "",\n "policy_name": "",\n "policy_type": "",\n "retention_length": "",\n "retention_type": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/retention_policies")
.post(body)
.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/retention_policies',
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({
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
policy_type: '',
retention_length: '',
retention_type: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/retention_policies',
headers: {'content-type': 'application/json'},
body: {
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
policy_type: '',
retention_length: '',
retention_type: ''
},
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}}/retention_policies');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [
{}
],
description: '',
disposition_action: '',
policy_name: '',
policy_type: '',
retention_length: '',
retention_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: 'POST',
url: '{{baseUrl}}/retention_policies',
headers: {'content-type': 'application/json'},
data: {
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
policy_type: '',
retention_length: '',
retention_type: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policies';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"are_owners_notified":false,"can_owner_extend_retention":false,"custom_notification_recipients":[{}],"description":"","disposition_action":"","policy_name":"","policy_type":"","retention_length":"","retention_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": @"application/json" };
NSDictionary *parameters = @{ @"are_owners_notified": @NO,
@"can_owner_extend_retention": @NO,
@"custom_notification_recipients": @[ @{ } ],
@"description": @"",
@"disposition_action": @"",
@"policy_name": @"",
@"policy_type": @"",
@"retention_length": @"",
@"retention_type": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policies"]
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}}/retention_policies" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policies",
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([
'are_owners_notified' => null,
'can_owner_extend_retention' => null,
'custom_notification_recipients' => [
[
]
],
'description' => '',
'disposition_action' => '',
'policy_name' => '',
'policy_type' => '',
'retention_length' => '',
'retention_type' => ''
]),
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('POST', '{{baseUrl}}/retention_policies', [
'body' => '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policies');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'are_owners_notified' => null,
'can_owner_extend_retention' => null,
'custom_notification_recipients' => [
[
]
],
'description' => '',
'disposition_action' => '',
'policy_name' => '',
'policy_type' => '',
'retention_length' => '',
'retention_type' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'are_owners_notified' => null,
'can_owner_extend_retention' => null,
'custom_notification_recipients' => [
[
]
],
'description' => '',
'disposition_action' => '',
'policy_name' => '',
'policy_type' => '',
'retention_length' => '',
'retention_type' => ''
]));
$request->setRequestUrl('{{baseUrl}}/retention_policies');
$request->setRequestMethod('POST');
$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}}/retention_policies' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policies' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/retention_policies", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policies"
payload = {
"are_owners_notified": False,
"can_owner_extend_retention": False,
"custom_notification_recipients": [{}],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policies"
payload <- "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\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}}/retention_policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\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/retention_policies') do |req|
req.body = "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"policy_type\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policies";
let payload = json!({
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": (json!({})),
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/retention_policies \
--header 'content-type: application/json' \
--data '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}'
echo '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
}' | \
http POST {{baseUrl}}/retention_policies \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "are_owners_notified": false,\n "can_owner_extend_retention": false,\n "custom_notification_recipients": [\n {}\n ],\n "description": "",\n "disposition_action": "",\n "policy_name": "",\n "policy_type": "",\n "retention_length": "",\n "retention_type": ""\n}' \
--output-document \
- {{baseUrl}}/retention_policies
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [[]],
"description": "",
"disposition_action": "",
"policy_name": "",
"policy_type": "",
"retention_length": "",
"retention_type": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policies")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete retention policy
{{baseUrl}}/retention_policies/:retention_policy_id
QUERY PARAMS
retention_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policies/:retention_policy_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/retention_policies/:retention_policy_id")
require "http/client"
url = "{{baseUrl}}/retention_policies/:retention_policy_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/retention_policies/:retention_policy_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policies/:retention_policy_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policies/:retention_policy_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/retention_policies/:retention_policy_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/retention_policies/:retention_policy_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policies/:retention_policy_id"))
.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}}/retention_policies/:retention_policy_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/retention_policies/:retention_policy_id")
.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}}/retention_policies/:retention_policy_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/retention_policies/:retention_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policies/:retention_policy_id';
const options = {method: 'DELETE'};
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}}/retention_policies/:retention_policy_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policies/:retention_policy_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policies/:retention_policy_id',
headers: {}
};
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}}/retention_policies/:retention_policy_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/retention_policies/:retention_policy_id');
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}}/retention_policies/:retention_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policies/:retention_policy_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policies/:retention_policy_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/retention_policies/:retention_policy_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policies/:retention_policy_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/retention_policies/:retention_policy_id');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policies/:retention_policy_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policies/:retention_policy_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policies/:retention_policy_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policies/:retention_policy_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/retention_policies/:retention_policy_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policies/:retention_policy_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policies/:retention_policy_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policies/:retention_policy_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/retention_policies/:retention_policy_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policies/:retention_policy_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/retention_policies/:retention_policy_id
http DELETE {{baseUrl}}/retention_policies/:retention_policy_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/retention_policies/:retention_policy_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policies/:retention_policy_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get retention policy
{{baseUrl}}/retention_policies/:retention_policy_id
QUERY PARAMS
retention_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policies/:retention_policy_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/retention_policies/:retention_policy_id")
require "http/client"
url = "{{baseUrl}}/retention_policies/:retention_policy_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/retention_policies/:retention_policy_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policies/:retention_policy_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policies/:retention_policy_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/retention_policies/:retention_policy_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/retention_policies/:retention_policy_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policies/:retention_policy_id"))
.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}}/retention_policies/:retention_policy_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/retention_policies/:retention_policy_id")
.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}}/retention_policies/:retention_policy_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/retention_policies/:retention_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policies/:retention_policy_id';
const options = {method: 'GET'};
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}}/retention_policies/:retention_policy_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policies/:retention_policy_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policies/:retention_policy_id',
headers: {}
};
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}}/retention_policies/:retention_policy_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/retention_policies/:retention_policy_id');
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}}/retention_policies/:retention_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policies/:retention_policy_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policies/:retention_policy_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/retention_policies/:retention_policy_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policies/:retention_policy_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/retention_policies/:retention_policy_id');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policies/:retention_policy_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policies/:retention_policy_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policies/:retention_policy_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policies/:retention_policy_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/retention_policies/:retention_policy_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policies/:retention_policy_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policies/:retention_policy_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policies/:retention_policy_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/retention_policies/:retention_policy_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policies/:retention_policy_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/retention_policies/:retention_policy_id
http GET {{baseUrl}}/retention_policies/:retention_policy_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/retention_policies/:retention_policy_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policies/:retention_policy_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List retention policies
{{baseUrl}}/retention_policies
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policies");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/retention_policies")
require "http/client"
url = "{{baseUrl}}/retention_policies"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/retention_policies"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policies");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policies"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/retention_policies HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/retention_policies")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policies"))
.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}}/retention_policies")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/retention_policies")
.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}}/retention_policies');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/retention_policies'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policies';
const options = {method: 'GET'};
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}}/retention_policies',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policies")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policies',
headers: {}
};
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}}/retention_policies'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/retention_policies');
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}}/retention_policies'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policies';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policies"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/retention_policies" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/retention_policies');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policies');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policies');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policies' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policies' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/retention_policies")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policies"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policies"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/retention_policies') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policies";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/retention_policies
http GET {{baseUrl}}/retention_policies
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/retention_policies
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policies")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update retention policy
{{baseUrl}}/retention_policies/:retention_policy_id
QUERY PARAMS
retention_policy_id
BODY json
{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policies/:retention_policy_id");
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 \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/retention_policies/:retention_policy_id" {:content-type :json
:form-params {:are_owners_notified false
:can_owner_extend_retention false
:custom_notification_recipients [{}]
:description ""
:disposition_action ""
:policy_name ""
:retention_length ""
:retention_type ""
:status ""}})
require "http/client"
url = "{{baseUrl}}/retention_policies/:retention_policy_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\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}}/retention_policies/:retention_policy_id"),
Content = new StringContent("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\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}}/retention_policies/:retention_policy_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policies/:retention_policy_id"
payload := strings.NewReader("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\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/retention_policies/:retention_policy_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 259
{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/retention_policies/:retention_policy_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policies/:retention_policy_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\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 \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/retention_policies/:retention_policy_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/retention_policies/:retention_policy_id")
.header("content-type", "application/json")
.body("{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}")
.asString();
const data = JSON.stringify({
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [
{}
],
description: '',
disposition_action: '',
policy_name: '',
retention_length: '',
retention_type: '',
status: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/retention_policies/:retention_policy_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/retention_policies/:retention_policy_id',
headers: {'content-type': 'application/json'},
data: {
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
retention_length: '',
retention_type: '',
status: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policies/:retention_policy_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"are_owners_notified":false,"can_owner_extend_retention":false,"custom_notification_recipients":[{}],"description":"","disposition_action":"","policy_name":"","retention_length":"","retention_type":"","status":""}'
};
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}}/retention_policies/:retention_policy_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "are_owners_notified": false,\n "can_owner_extend_retention": false,\n "custom_notification_recipients": [\n {}\n ],\n "description": "",\n "disposition_action": "",\n "policy_name": "",\n "retention_length": "",\n "retention_type": "",\n "status": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/retention_policies/:retention_policy_id")
.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/retention_policies/:retention_policy_id',
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({
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
retention_length: '',
retention_type: '',
status: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/retention_policies/:retention_policy_id',
headers: {'content-type': 'application/json'},
body: {
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
retention_length: '',
retention_type: '',
status: ''
},
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}}/retention_policies/:retention_policy_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [
{}
],
description: '',
disposition_action: '',
policy_name: '',
retention_length: '',
retention_type: '',
status: ''
});
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}}/retention_policies/:retention_policy_id',
headers: {'content-type': 'application/json'},
data: {
are_owners_notified: false,
can_owner_extend_retention: false,
custom_notification_recipients: [{}],
description: '',
disposition_action: '',
policy_name: '',
retention_length: '',
retention_type: '',
status: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policies/:retention_policy_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"are_owners_notified":false,"can_owner_extend_retention":false,"custom_notification_recipients":[{}],"description":"","disposition_action":"","policy_name":"","retention_length":"","retention_type":"","status":""}'
};
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 = @{ @"are_owners_notified": @NO,
@"can_owner_extend_retention": @NO,
@"custom_notification_recipients": @[ @{ } ],
@"description": @"",
@"disposition_action": @"",
@"policy_name": @"",
@"retention_length": @"",
@"retention_type": @"",
@"status": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policies/:retention_policy_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}}/retention_policies/:retention_policy_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policies/:retention_policy_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([
'are_owners_notified' => null,
'can_owner_extend_retention' => null,
'custom_notification_recipients' => [
[
]
],
'description' => '',
'disposition_action' => '',
'policy_name' => '',
'retention_length' => '',
'retention_type' => '',
'status' => ''
]),
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}}/retention_policies/:retention_policy_id', [
'body' => '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policies/:retention_policy_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'are_owners_notified' => null,
'can_owner_extend_retention' => null,
'custom_notification_recipients' => [
[
]
],
'description' => '',
'disposition_action' => '',
'policy_name' => '',
'retention_length' => '',
'retention_type' => '',
'status' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'are_owners_notified' => null,
'can_owner_extend_retention' => null,
'custom_notification_recipients' => [
[
]
],
'description' => '',
'disposition_action' => '',
'policy_name' => '',
'retention_length' => '',
'retention_type' => '',
'status' => ''
]));
$request->setRequestUrl('{{baseUrl}}/retention_policies/:retention_policy_id');
$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}}/retention_policies/:retention_policy_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policies/:retention_policy_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/retention_policies/:retention_policy_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policies/:retention_policy_id"
payload = {
"are_owners_notified": False,
"can_owner_extend_retention": False,
"custom_notification_recipients": [{}],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policies/:retention_policy_id"
payload <- "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\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}}/retention_policies/:retention_policy_id")
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 \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\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/retention_policies/:retention_policy_id') do |req|
req.body = "{\n \"are_owners_notified\": false,\n \"can_owner_extend_retention\": false,\n \"custom_notification_recipients\": [\n {}\n ],\n \"description\": \"\",\n \"disposition_action\": \"\",\n \"policy_name\": \"\",\n \"retention_length\": \"\",\n \"retention_type\": \"\",\n \"status\": \"\"\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}}/retention_policies/:retention_policy_id";
let payload = json!({
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": (json!({})),
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
});
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}}/retention_policies/:retention_policy_id \
--header 'content-type: application/json' \
--data '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}'
echo '{
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [
{}
],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
}' | \
http PUT {{baseUrl}}/retention_policies/:retention_policy_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "are_owners_notified": false,\n "can_owner_extend_retention": false,\n "custom_notification_recipients": [\n {}\n ],\n "description": "",\n "disposition_action": "",\n "policy_name": "",\n "retention_length": "",\n "retention_type": "",\n "status": ""\n}' \
--output-document \
- {{baseUrl}}/retention_policies/:retention_policy_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"are_owners_notified": false,
"can_owner_extend_retention": false,
"custom_notification_recipients": [[]],
"description": "",
"disposition_action": "",
"policy_name": "",
"retention_length": "",
"retention_type": "",
"status": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policies/:retention_policy_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Assign retention policy
{{baseUrl}}/retention_policy_assignments
BODY json
{
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policy_assignments");
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 \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/retention_policy_assignments" {:content-type :json
:form-params {:assign_to {:id ""
:type ""}
:filter_fields [{:field ""
:value ""}]
:policy_id ""
:start_date_field ""}})
require "http/client"
url = "{{baseUrl}}/retention_policy_assignments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\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}}/retention_policy_assignments"),
Content = new StringContent("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\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}}/retention_policy_assignments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policy_assignments"
payload := strings.NewReader("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/retention_policy_assignments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 173
{
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/retention_policy_assignments")
.setHeader("content-type", "application/json")
.setBody("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policy_assignments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\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 \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/retention_policy_assignments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/retention_policy_assignments")
.header("content-type", "application/json")
.body("{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}")
.asString();
const data = JSON.stringify({
assign_to: {
id: '',
type: ''
},
filter_fields: [
{
field: '',
value: ''
}
],
policy_id: '',
start_date_field: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/retention_policy_assignments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/retention_policy_assignments',
headers: {'content-type': 'application/json'},
data: {
assign_to: {id: '', type: ''},
filter_fields: [{field: '', value: ''}],
policy_id: '',
start_date_field: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policy_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assign_to":{"id":"","type":""},"filter_fields":[{"field":"","value":""}],"policy_id":"","start_date_field":""}'
};
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}}/retention_policy_assignments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "assign_to": {\n "id": "",\n "type": ""\n },\n "filter_fields": [\n {\n "field": "",\n "value": ""\n }\n ],\n "policy_id": "",\n "start_date_field": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/retention_policy_assignments")
.post(body)
.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/retention_policy_assignments',
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({
assign_to: {id: '', type: ''},
filter_fields: [{field: '', value: ''}],
policy_id: '',
start_date_field: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/retention_policy_assignments',
headers: {'content-type': 'application/json'},
body: {
assign_to: {id: '', type: ''},
filter_fields: [{field: '', value: ''}],
policy_id: '',
start_date_field: ''
},
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}}/retention_policy_assignments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
assign_to: {
id: '',
type: ''
},
filter_fields: [
{
field: '',
value: ''
}
],
policy_id: '',
start_date_field: ''
});
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}}/retention_policy_assignments',
headers: {'content-type': 'application/json'},
data: {
assign_to: {id: '', type: ''},
filter_fields: [{field: '', value: ''}],
policy_id: '',
start_date_field: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policy_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assign_to":{"id":"","type":""},"filter_fields":[{"field":"","value":""}],"policy_id":"","start_date_field":""}'
};
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 = @{ @"assign_to": @{ @"id": @"", @"type": @"" },
@"filter_fields": @[ @{ @"field": @"", @"value": @"" } ],
@"policy_id": @"",
@"start_date_field": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policy_assignments"]
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}}/retention_policy_assignments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policy_assignments",
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([
'assign_to' => [
'id' => '',
'type' => ''
],
'filter_fields' => [
[
'field' => '',
'value' => ''
]
],
'policy_id' => '',
'start_date_field' => ''
]),
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('POST', '{{baseUrl}}/retention_policy_assignments', [
'body' => '{
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policy_assignments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'assign_to' => [
'id' => '',
'type' => ''
],
'filter_fields' => [
[
'field' => '',
'value' => ''
]
],
'policy_id' => '',
'start_date_field' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'assign_to' => [
'id' => '',
'type' => ''
],
'filter_fields' => [
[
'field' => '',
'value' => ''
]
],
'policy_id' => '',
'start_date_field' => ''
]));
$request->setRequestUrl('{{baseUrl}}/retention_policy_assignments');
$request->setRequestMethod('POST');
$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}}/retention_policy_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policy_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/retention_policy_assignments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policy_assignments"
payload = {
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policy_assignments"
payload <- "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\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}}/retention_policy_assignments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\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/retention_policy_assignments') do |req|
req.body = "{\n \"assign_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"filter_fields\": [\n {\n \"field\": \"\",\n \"value\": \"\"\n }\n ],\n \"policy_id\": \"\",\n \"start_date_field\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policy_assignments";
let payload = json!({
"assign_to": json!({
"id": "",
"type": ""
}),
"filter_fields": (
json!({
"field": "",
"value": ""
})
),
"policy_id": "",
"start_date_field": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/retention_policy_assignments \
--header 'content-type: application/json' \
--data '{
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}'
echo '{
"assign_to": {
"id": "",
"type": ""
},
"filter_fields": [
{
"field": "",
"value": ""
}
],
"policy_id": "",
"start_date_field": ""
}' | \
http POST {{baseUrl}}/retention_policy_assignments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "assign_to": {\n "id": "",\n "type": ""\n },\n "filter_fields": [\n {\n "field": "",\n "value": ""\n }\n ],\n "policy_id": "",\n "start_date_field": ""\n}' \
--output-document \
- {{baseUrl}}/retention_policy_assignments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"assign_to": [
"id": "",
"type": ""
],
"filter_fields": [
[
"field": "",
"value": ""
]
],
"policy_id": "",
"start_date_field": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policy_assignments")! 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
{
"assigned_at": "2012-12-12T10:53:43-08:00",
"assigned_to": {
"id": "a983f69f-e85f-4ph4-9f46-4afdf9c1af65",
"type": "metadata_template"
},
"id": "11446498",
"start_date_field": "upload_date",
"type": "retention_policy_assignment"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get file versions under retention
{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention
QUERY PARAMS
retention_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")
require "http/client"
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention"))
.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}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")
.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}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention';
const options = {method: 'GET'};
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}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention',
headers: {}
};
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}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention');
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}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention
http GET {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get files under retention
{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention
QUERY PARAMS
retention_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")
require "http/client"
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention"))
.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}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")
.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}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention';
const options = {method: 'GET'};
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}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention',
headers: {}
};
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}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention');
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}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention
http GET {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get retention policy assignment
{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
QUERY PARAMS
retention_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
require "http/client"
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/retention_policy_assignments/:retention_policy_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"))
.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}}/retention_policy_assignments/:retention_policy_assignment_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
.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}}/retention_policy_assignments/:retention_policy_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id';
const options = {method: 'GET'};
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}}/retention_policy_assignments/:retention_policy_assignment_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policy_assignments/:retention_policy_assignment_id',
headers: {}
};
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}}/retention_policy_assignments/:retention_policy_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
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}}/retention_policy_assignments/:retention_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/retention_policy_assignments/:retention_policy_assignment_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/retention_policy_assignments/:retention_policy_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/retention_policy_assignments/:retention_policy_assignment_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
http GET {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"assigned_at": "2012-12-12T10:53:43-08:00",
"assigned_to": {
"id": "a983f69f-e85f-4ph4-9f46-4afdf9c1af65",
"type": "metadata_template"
},
"id": "11446498",
"start_date_field": "upload_date",
"type": "retention_policy_assignment"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List retention policy assignments
{{baseUrl}}/retention_policies/:retention_policy_id/assignments
QUERY PARAMS
retention_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policies/:retention_policy_id/assignments");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/retention_policies/:retention_policy_id/assignments")
require "http/client"
url = "{{baseUrl}}/retention_policies/:retention_policy_id/assignments"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/retention_policies/:retention_policy_id/assignments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policies/:retention_policy_id/assignments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policies/:retention_policy_id/assignments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/retention_policies/:retention_policy_id/assignments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/retention_policies/:retention_policy_id/assignments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policies/:retention_policy_id/assignments"))
.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}}/retention_policies/:retention_policy_id/assignments")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/retention_policies/:retention_policy_id/assignments")
.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}}/retention_policies/:retention_policy_id/assignments');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/retention_policies/:retention_policy_id/assignments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policies/:retention_policy_id/assignments';
const options = {method: 'GET'};
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}}/retention_policies/:retention_policy_id/assignments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policies/:retention_policy_id/assignments")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policies/:retention_policy_id/assignments',
headers: {}
};
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}}/retention_policies/:retention_policy_id/assignments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/retention_policies/:retention_policy_id/assignments');
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}}/retention_policies/:retention_policy_id/assignments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policies/:retention_policy_id/assignments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policies/:retention_policy_id/assignments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/retention_policies/:retention_policy_id/assignments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policies/:retention_policy_id/assignments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/retention_policies/:retention_policy_id/assignments');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policies/:retention_policy_id/assignments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policies/:retention_policy_id/assignments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policies/:retention_policy_id/assignments' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policies/:retention_policy_id/assignments' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/retention_policies/:retention_policy_id/assignments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policies/:retention_policy_id/assignments"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policies/:retention_policy_id/assignments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policies/:retention_policy_id/assignments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/retention_policies/:retention_policy_id/assignments') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policies/:retention_policy_id/assignments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/retention_policies/:retention_policy_id/assignments
http GET {{baseUrl}}/retention_policies/:retention_policy_id/assignments
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/retention_policies/:retention_policy_id/assignments
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policies/:retention_policy_id/assignments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove retention policy assignment
{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
QUERY PARAMS
retention_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
require "http/client"
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/retention_policy_assignments/:retention_policy_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"))
.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}}/retention_policy_assignments/:retention_policy_assignment_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
.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}}/retention_policy_assignments/:retention_policy_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id';
const options = {method: 'DELETE'};
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}}/retention_policy_assignments/:retention_policy_assignment_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/retention_policy_assignments/:retention_policy_assignment_id',
headers: {}
};
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}}/retention_policy_assignments/:retention_policy_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
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}}/retention_policy_assignments/:retention_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/retention_policy_assignments/:retention_policy_assignment_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/retention_policy_assignments/:retention_policy_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/retention_policy_assignments/:retention_policy_assignment_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
http DELETE {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/retention_policy_assignments/:retention_policy_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List metadata query indices
{{baseUrl}}/metadata_query_indices
QUERY PARAMS
scope
template_key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_query_indices?scope=&template_key=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata_query_indices" {:query-params {:scope ""
:template_key ""}})
require "http/client"
url = "{{baseUrl}}/metadata_query_indices?scope=&template_key="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata_query_indices?scope=&template_key="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata_query_indices?scope=&template_key=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_query_indices?scope=&template_key="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata_query_indices?scope=&template_key= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata_query_indices?scope=&template_key=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_query_indices?scope=&template_key="))
.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}}/metadata_query_indices?scope=&template_key=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata_query_indices?scope=&template_key=")
.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}}/metadata_query_indices?scope=&template_key=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata_query_indices',
params: {scope: '', template_key: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_query_indices?scope=&template_key=';
const options = {method: 'GET'};
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}}/metadata_query_indices?scope=&template_key=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata_query_indices?scope=&template_key=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata_query_indices?scope=&template_key=',
headers: {}
};
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}}/metadata_query_indices',
qs: {scope: '', template_key: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata_query_indices');
req.query({
scope: '',
template_key: ''
});
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}}/metadata_query_indices',
params: {scope: '', template_key: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_query_indices?scope=&template_key=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_query_indices?scope=&template_key="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata_query_indices?scope=&template_key=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_query_indices?scope=&template_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/metadata_query_indices?scope=&template_key=');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_query_indices');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'scope' => '',
'template_key' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata_query_indices');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'scope' => '',
'template_key' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata_query_indices?scope=&template_key=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_query_indices?scope=&template_key=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata_query_indices?scope=&template_key=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_query_indices"
querystring = {"scope":"","template_key":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_query_indices"
queryString <- list(
scope = "",
template_key = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata_query_indices?scope=&template_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata_query_indices') do |req|
req.params['scope'] = ''
req.params['template_key'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_query_indices";
let querystring = [
("scope", ""),
("template_key", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/metadata_query_indices?scope=&template_key='
http GET '{{baseUrl}}/metadata_query_indices?scope=&template_key='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/metadata_query_indices?scope=&template_key='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_query_indices?scope=&template_key=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 100,
"next_marker": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ.."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Query files-folders by metadata
{{baseUrl}}/metadata_queries/execute_read
BODY json
{
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata_queries/execute_read");
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 \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata_queries/execute_read" {:content-type :json
:form-params {:ancestor_folder_id ""
:fields []
:from ""
:limit 0
:marker ""
:order_by [{:direction ""
:field_key ""}]
:query ""
:query_params {}}})
require "http/client"
url = "{{baseUrl}}/metadata_queries/execute_read"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\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}}/metadata_queries/execute_read"),
Content = new StringContent("{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\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}}/metadata_queries/execute_read");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata_queries/execute_read"
payload := strings.NewReader("{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/metadata_queries/execute_read HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 205
{
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata_queries/execute_read")
.setHeader("content-type", "application/json")
.setBody("{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata_queries/execute_read"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\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 \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata_queries/execute_read")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata_queries/execute_read")
.header("content-type", "application/json")
.body("{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}")
.asString();
const data = JSON.stringify({
ancestor_folder_id: '',
fields: [],
from: '',
limit: 0,
marker: '',
order_by: [
{
direction: '',
field_key: ''
}
],
query: '',
query_params: {}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata_queries/execute_read');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_queries/execute_read',
headers: {'content-type': 'application/json'},
data: {
ancestor_folder_id: '',
fields: [],
from: '',
limit: 0,
marker: '',
order_by: [{direction: '', field_key: ''}],
query: '',
query_params: {}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata_queries/execute_read';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"ancestor_folder_id":"","fields":[],"from":"","limit":0,"marker":"","order_by":[{"direction":"","field_key":""}],"query":"","query_params":{}}'
};
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}}/metadata_queries/execute_read',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "ancestor_folder_id": "",\n "fields": [],\n "from": "",\n "limit": 0,\n "marker": "",\n "order_by": [\n {\n "direction": "",\n "field_key": ""\n }\n ],\n "query": "",\n "query_params": {}\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata_queries/execute_read")
.post(body)
.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/metadata_queries/execute_read',
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({
ancestor_folder_id: '',
fields: [],
from: '',
limit: 0,
marker: '',
order_by: [{direction: '', field_key: ''}],
query: '',
query_params: {}
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata_queries/execute_read',
headers: {'content-type': 'application/json'},
body: {
ancestor_folder_id: '',
fields: [],
from: '',
limit: 0,
marker: '',
order_by: [{direction: '', field_key: ''}],
query: '',
query_params: {}
},
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}}/metadata_queries/execute_read');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
ancestor_folder_id: '',
fields: [],
from: '',
limit: 0,
marker: '',
order_by: [
{
direction: '',
field_key: ''
}
],
query: '',
query_params: {}
});
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}}/metadata_queries/execute_read',
headers: {'content-type': 'application/json'},
data: {
ancestor_folder_id: '',
fields: [],
from: '',
limit: 0,
marker: '',
order_by: [{direction: '', field_key: ''}],
query: '',
query_params: {}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata_queries/execute_read';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"ancestor_folder_id":"","fields":[],"from":"","limit":0,"marker":"","order_by":[{"direction":"","field_key":""}],"query":"","query_params":{}}'
};
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 = @{ @"ancestor_folder_id": @"",
@"fields": @[ ],
@"from": @"",
@"limit": @0,
@"marker": @"",
@"order_by": @[ @{ @"direction": @"", @"field_key": @"" } ],
@"query": @"",
@"query_params": @{ } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata_queries/execute_read"]
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}}/metadata_queries/execute_read" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata_queries/execute_read",
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([
'ancestor_folder_id' => '',
'fields' => [
],
'from' => '',
'limit' => 0,
'marker' => '',
'order_by' => [
[
'direction' => '',
'field_key' => ''
]
],
'query' => '',
'query_params' => [
]
]),
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('POST', '{{baseUrl}}/metadata_queries/execute_read', [
'body' => '{
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata_queries/execute_read');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'ancestor_folder_id' => '',
'fields' => [
],
'from' => '',
'limit' => 0,
'marker' => '',
'order_by' => [
[
'direction' => '',
'field_key' => ''
]
],
'query' => '',
'query_params' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'ancestor_folder_id' => '',
'fields' => [
],
'from' => '',
'limit' => 0,
'marker' => '',
'order_by' => [
[
'direction' => '',
'field_key' => ''
]
],
'query' => '',
'query_params' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/metadata_queries/execute_read');
$request->setRequestMethod('POST');
$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}}/metadata_queries/execute_read' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata_queries/execute_read' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata_queries/execute_read", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata_queries/execute_read"
payload = {
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata_queries/execute_read"
payload <- "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\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}}/metadata_queries/execute_read")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\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/metadata_queries/execute_read') do |req|
req.body = "{\n \"ancestor_folder_id\": \"\",\n \"fields\": [],\n \"from\": \"\",\n \"limit\": 0,\n \"marker\": \"\",\n \"order_by\": [\n {\n \"direction\": \"\",\n \"field_key\": \"\"\n }\n ],\n \"query\": \"\",\n \"query_params\": {}\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata_queries/execute_read";
let payload = json!({
"ancestor_folder_id": "",
"fields": (),
"from": "",
"limit": 0,
"marker": "",
"order_by": (
json!({
"direction": "",
"field_key": ""
})
),
"query": "",
"query_params": json!({})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/metadata_queries/execute_read \
--header 'content-type: application/json' \
--data '{
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}'
echo '{
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
{
"direction": "",
"field_key": ""
}
],
"query": "",
"query_params": {}
}' | \
http POST {{baseUrl}}/metadata_queries/execute_read \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "ancestor_folder_id": "",\n "fields": [],\n "from": "",\n "limit": 0,\n "marker": "",\n "order_by": [\n {\n "direction": "",\n "field_key": ""\n }\n ],\n "query": "",\n "query_params": {}\n}' \
--output-document \
- {{baseUrl}}/metadata_queries/execute_read
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"ancestor_folder_id": "",
"fields": [],
"from": "",
"limit": 0,
"marker": "",
"order_by": [
[
"direction": "",
"field_key": ""
]
],
"query": "",
"query_params": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata_queries/execute_read")! 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
{
"limit": 100,
"next_marker": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ.."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Search for content
{{baseUrl}}/search
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/search");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/search")
require "http/client"
url = "{{baseUrl}}/search"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/search"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/search");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/search HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/search")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/search"))
.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}}/search")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/search")
.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}}/search');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/search'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/search';
const options = {method: 'GET'};
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}}/search',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/search")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/search',
headers: {}
};
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}}/search'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/search');
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}}/search'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/search';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/search"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/search" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/search');
echo $response->getBody();
setUrl('{{baseUrl}}/search');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/search');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/search' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/search' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/search")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/search"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/search"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/search') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/search";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/search
http GET {{baseUrl}}/search
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/search
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/search")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id?fields=#add_shared_link");
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id#add_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {:access ""
:password ""
:permissions {:can_download false
:can_edit false
:can_preview false}
:unshared_at ""
:vanity_name ""}}})
require "http/client"
url = "{{baseUrl}}/files/:file_id?fields=#add_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/files/:file_id?fields=#add_shared_link"),
Content = new StringContent("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/files/:file_id?fields=#add_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id?fields=#add_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/files/:file_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 218
{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id?fields=#add_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id?fields=#add_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id?fields=#add_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id?fields=#add_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/files/:file_id?fields=#add_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id#add_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id?fields=#add_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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}}/files/:file_id?fields=#add_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id?fields=#add_shared_link")
.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/files/:file_id?fields=',
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({
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id#add_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
},
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}}/files/:file_id#add_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
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}}/files/:file_id#add_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id?fields=#add_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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 = @{ @"shared_link": @{ @"access": @"", @"password": @"", @"permissions": @{ @"can_download": @NO, @"can_edit": @NO, @"can_preview": @NO }, @"unshared_at": @"", @"vanity_name": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id?fields=#add_shared_link"]
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}}/files/:file_id?fields=#add_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id?fields=#add_shared_link",
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([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]),
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}}/files/:file_id?fields=#add_shared_link', [
'body' => '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id#add_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id#add_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/files/:file_id?fields=#add_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id?fields=#add_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/files/:file_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id#add_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": False,
"can_edit": False,
"can_preview": False
},
"unshared_at": "",
"vanity_name": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id#add_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id?fields=#add_shared_link")
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/files/:file_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/files/:file_id#add_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({
"access": "",
"password": "",
"permissions": json!({
"can_download": false,
"can_edit": false,
"can_preview": false
}),
"unshared_at": "",
"vanity_name": ""
})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/files/:file_id?fields=#add_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
echo '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}' | \
http PUT '{{baseUrl}}/files/:file_id?fields=#add_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/files/:file_id?fields=#add_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": [
"access": "",
"password": "",
"permissions": [
"can_download": false,
"can_edit": false,
"can_preview": false
],
"unshared_at": "",
"vanity_name": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id?fields=#add_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": true,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "file"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shared_items");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "boxapi: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shared_items" {:headers {:boxapi ""}})
require "http/client"
url = "{{baseUrl}}/shared_items"
headers = HTTP::Headers{
"boxapi" => ""
}
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}}/shared_items"),
Headers =
{
{ "boxapi", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shared_items");
var request = new RestRequest("", Method.Get);
request.AddHeader("boxapi", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shared_items"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("boxapi", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shared_items HTTP/1.1
Boxapi:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shared_items")
.setHeader("boxapi", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shared_items"))
.header("boxapi", "")
.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}}/shared_items")
.get()
.addHeader("boxapi", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shared_items")
.header("boxapi", "")
.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}}/shared_items');
xhr.setRequestHeader('boxapi', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shared_items',
headers: {boxapi: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shared_items';
const options = {method: 'GET', headers: {boxapi: ''}};
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}}/shared_items',
method: 'GET',
headers: {
boxapi: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shared_items")
.get()
.addHeader("boxapi", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shared_items',
headers: {
boxapi: ''
}
};
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}}/shared_items',
headers: {boxapi: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shared_items');
req.headers({
boxapi: ''
});
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}}/shared_items',
headers: {boxapi: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shared_items';
const options = {method: 'GET', headers: {boxapi: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"boxapi": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shared_items"]
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}}/shared_items" in
let headers = Header.add (Header.init ()) "boxapi" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shared_items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"boxapi: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shared_items', [
'headers' => [
'boxapi' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shared_items');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'boxapi' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shared_items');
$request->setRequestMethod('GET');
$request->setHeaders([
'boxapi' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("boxapi", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shared_items' -Method GET -Headers $headers
$headers=@{}
$headers.Add("boxapi", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shared_items' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'boxapi': "" }
conn.request("GET", "/baseUrl/shared_items", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shared_items"
headers = {"boxapi": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shared_items"
response <- VERB("GET", url, add_headers('boxapi' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shared_items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["boxapi"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shared_items') do |req|
req.headers['boxapi'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shared_items";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("boxapi", "".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}}/shared_items \
--header 'boxapi: '
http GET {{baseUrl}}/shared_items \
boxapi:''
wget --quiet \
--method GET \
--header 'boxapi: ' \
--output-document \
- {{baseUrl}}/shared_items
import Foundation
let headers = ["boxapi": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shared_items")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id?fields=#get_shared_link");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id#get_shared_link" {:query-params {:fields ""}})
require "http/client"
url = "{{baseUrl}}/files/:file_id?fields=#get_shared_link"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id?fields=#get_shared_link"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id?fields=#get_shared_link");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id?fields=#get_shared_link"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id?fields= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id?fields=#get_shared_link")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id?fields=#get_shared_link"))
.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}}/files/:file_id?fields=#get_shared_link")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id?fields=#get_shared_link")
.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}}/files/:file_id?fields=#get_shared_link');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id#get_shared_link',
params: {fields: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id?fields=#get_shared_link';
const options = {method: 'GET'};
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}}/files/:file_id?fields=#get_shared_link',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id?fields=#get_shared_link")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id?fields=',
headers: {}
};
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}}/files/:file_id#get_shared_link',
qs: {fields: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id#get_shared_link');
req.query({
fields: ''
});
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}}/files/:file_id#get_shared_link',
params: {fields: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id?fields=#get_shared_link';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id?fields=#get_shared_link"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id?fields=#get_shared_link" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id?fields=#get_shared_link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id?fields=#get_shared_link');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id#get_shared_link');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'fields' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id#get_shared_link');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id?fields=#get_shared_link' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id?fields=#get_shared_link' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id?fields=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id#get_shared_link"
querystring = {"fields":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id#get_shared_link"
queryString <- list(fields = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id?fields=#get_shared_link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id') do |req|
req.params['fields'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id#get_shared_link";
let querystring = [
("fields", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/files/:file_id?fields=#get_shared_link'
http GET '{{baseUrl}}/files/:file_id?fields=#get_shared_link'
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/files/:file_id?fields=#get_shared_link'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id?fields=#get_shared_link")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": true,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "file"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id?fields=#remove_shared_link");
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 \"shared_link\": {}\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id#remove_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {}}})
require "http/client"
url = "{{baseUrl}}/files/:file_id?fields=#remove_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {}\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}}/files/:file_id?fields=#remove_shared_link"),
Content = new StringContent("{\n \"shared_link\": {}\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}}/files/:file_id?fields=#remove_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {}\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id?fields=#remove_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {}\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/files/:file_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 23
{
"shared_link": {}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id?fields=#remove_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {}\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id?fields=#remove_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {}\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 \"shared_link\": {}\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id?fields=#remove_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id?fields=#remove_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {}\n}")
.asString();
const data = JSON.stringify({
shared_link: {}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/files/:file_id?fields=#remove_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id#remove_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {shared_link: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id?fields=#remove_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{}}'
};
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}}/files/:file_id?fields=#remove_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {}\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"shared_link\": {}\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id?fields=#remove_shared_link")
.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/files/:file_id?fields=',
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({shared_link: {}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id#remove_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {shared_link: {}},
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}}/files/:file_id#remove_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {}
});
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}}/files/:file_id#remove_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {shared_link: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id?fields=#remove_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{}}'
};
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 = @{ @"shared_link": @{ } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id?fields=#remove_shared_link"]
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}}/files/:file_id?fields=#remove_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {}\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id?fields=#remove_shared_link",
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([
'shared_link' => [
]
]),
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}}/files/:file_id?fields=#remove_shared_link', [
'body' => '{
"shared_link": {}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id#remove_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id#remove_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/files/:file_id?fields=#remove_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id?fields=#remove_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {}\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/files/:file_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id#remove_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id#remove_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {}\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id?fields=#remove_shared_link")
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 \"shared_link\": {}\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/files/:file_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {}\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}}/files/:file_id#remove_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/files/:file_id?fields=#remove_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {}
}'
echo '{
"shared_link": {}
}' | \
http PUT '{{baseUrl}}/files/:file_id?fields=#remove_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {}\n}' \
--output-document \
- '{{baseUrl}}/files/:file_id?fields=#remove_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id?fields=#remove_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": null,
"type": "file"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id?fields=#update_shared_link");
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id#update_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {:access ""
:password ""
:permissions {:can_download false
:can_edit false
:can_preview false}
:unshared_at ""
:vanity_name ""}}})
require "http/client"
url = "{{baseUrl}}/files/:file_id?fields=#update_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/files/:file_id?fields=#update_shared_link"),
Content = new StringContent("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/files/:file_id?fields=#update_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id?fields=#update_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/files/:file_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 218
{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id?fields=#update_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id?fields=#update_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id?fields=#update_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id?fields=#update_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/files/:file_id?fields=#update_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id#update_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id?fields=#update_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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}}/files/:file_id?fields=#update_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id?fields=#update_shared_link")
.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/files/:file_id?fields=',
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({
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id#update_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
},
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}}/files/:file_id#update_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
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}}/files/:file_id#update_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id?fields=#update_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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 = @{ @"shared_link": @{ @"access": @"", @"password": @"", @"permissions": @{ @"can_download": @NO, @"can_edit": @NO, @"can_preview": @NO }, @"unshared_at": @"", @"vanity_name": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id?fields=#update_shared_link"]
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}}/files/:file_id?fields=#update_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id?fields=#update_shared_link",
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([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]),
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}}/files/:file_id?fields=#update_shared_link', [
'body' => '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id#update_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id#update_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/files/:file_id?fields=#update_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id?fields=#update_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/files/:file_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id#update_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": False,
"can_edit": False,
"can_preview": False
},
"unshared_at": "",
"vanity_name": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id#update_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id?fields=#update_shared_link")
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/files/:file_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/files/:file_id#update_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({
"access": "",
"password": "",
"permissions": json!({
"can_download": false,
"can_edit": false,
"can_preview": false
}),
"unshared_at": "",
"vanity_name": ""
})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/files/:file_id?fields=#update_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
echo '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}' | \
http PUT '{{baseUrl}}/files/:file_id?fields=#update_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/files/:file_id?fields=#update_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": [
"access": "",
"password": "",
"permissions": [
"can_download": false,
"can_edit": false,
"can_preview": false
],
"unshared_at": "",
"vanity_name": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id?fields=#update_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": true,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "file"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id?fields=#add_shared_link");
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/folders/:folder_id#add_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {:access ""
:password ""
:permissions {:can_download false
:can_edit false
:can_preview false}
:unshared_at ""
:vanity_name ""}}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id?fields=#add_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/folders/:folder_id?fields=#add_shared_link"),
Content = new StringContent("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/folders/:folder_id?fields=#add_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id?fields=#add_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/folders/:folder_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 218
{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/folders/:folder_id?fields=#add_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id?fields=#add_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id?fields=#add_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/folders/:folder_id?fields=#add_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/folders/:folder_id?fields=#add_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id#add_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id?fields=#add_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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}}/folders/:folder_id?fields=#add_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id?fields=#add_shared_link")
.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/folders/:folder_id?fields=',
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({
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id#add_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
},
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}}/folders/:folder_id#add_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
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}}/folders/:folder_id#add_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id?fields=#add_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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 = @{ @"shared_link": @{ @"access": @"", @"password": @"", @"permissions": @{ @"can_download": @NO, @"can_edit": @NO, @"can_preview": @NO }, @"unshared_at": @"", @"vanity_name": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id?fields=#add_shared_link"]
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}}/folders/:folder_id?fields=#add_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id?fields=#add_shared_link",
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([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]),
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}}/folders/:folder_id?fields=#add_shared_link', [
'body' => '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id#add_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id#add_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/folders/:folder_id?fields=#add_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id?fields=#add_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/folders/:folder_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id#add_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": False,
"can_edit": False,
"can_preview": False
},
"unshared_at": "",
"vanity_name": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id#add_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id?fields=#add_shared_link")
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/folders/:folder_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/folders/:folder_id#add_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({
"access": "",
"password": "",
"permissions": json!({
"can_download": false,
"can_edit": false,
"can_preview": false
}),
"unshared_at": "",
"vanity_name": ""
})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/folders/:folder_id?fields=#add_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
echo '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}' | \
http PUT '{{baseUrl}}/folders/:folder_id?fields=#add_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/folders/:folder_id?fields=#add_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": [
"access": "",
"password": "",
"permissions": [
"can_download": false,
"can_edit": false,
"can_preview": false
],
"unshared_at": "",
"vanity_name": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id?fields=#add_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "folder"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shared_items#folders");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "boxapi: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shared_items#folders" {:headers {:boxapi ""}})
require "http/client"
url = "{{baseUrl}}/shared_items#folders"
headers = HTTP::Headers{
"boxapi" => ""
}
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}}/shared_items#folders"),
Headers =
{
{ "boxapi", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shared_items#folders");
var request = new RestRequest("", Method.Get);
request.AddHeader("boxapi", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shared_items#folders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("boxapi", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shared_items HTTP/1.1
Boxapi:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shared_items#folders")
.setHeader("boxapi", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shared_items#folders"))
.header("boxapi", "")
.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}}/shared_items#folders")
.get()
.addHeader("boxapi", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shared_items#folders")
.header("boxapi", "")
.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}}/shared_items#folders');
xhr.setRequestHeader('boxapi', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shared_items#folders',
headers: {boxapi: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shared_items#folders';
const options = {method: 'GET', headers: {boxapi: ''}};
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}}/shared_items#folders',
method: 'GET',
headers: {
boxapi: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shared_items#folders")
.get()
.addHeader("boxapi", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shared_items',
headers: {
boxapi: ''
}
};
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}}/shared_items#folders',
headers: {boxapi: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shared_items#folders');
req.headers({
boxapi: ''
});
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}}/shared_items#folders',
headers: {boxapi: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shared_items#folders';
const options = {method: 'GET', headers: {boxapi: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"boxapi": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shared_items#folders"]
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}}/shared_items#folders" in
let headers = Header.add (Header.init ()) "boxapi" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shared_items#folders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"boxapi: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shared_items#folders', [
'headers' => [
'boxapi' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shared_items#folders');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'boxapi' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shared_items#folders');
$request->setRequestMethod('GET');
$request->setHeaders([
'boxapi' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("boxapi", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shared_items#folders' -Method GET -Headers $headers
$headers=@{}
$headers.Add("boxapi", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shared_items#folders' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'boxapi': "" }
conn.request("GET", "/baseUrl/shared_items", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shared_items#folders"
headers = {"boxapi": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shared_items#folders"
response <- VERB("GET", url, add_headers('boxapi' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shared_items#folders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["boxapi"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shared_items') do |req|
req.headers['boxapi'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shared_items#folders";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("boxapi", "".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}}/shared_items#folders' \
--header 'boxapi: '
http GET '{{baseUrl}}/shared_items#folders' \
boxapi:''
wget --quiet \
--method GET \
--header 'boxapi: ' \
--output-document \
- '{{baseUrl}}/shared_items#folders'
import Foundation
let headers = ["boxapi": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shared_items#folders")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id?fields=#get_shared_link");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id#get_shared_link" {:query-params {:fields ""}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id?fields=#get_shared_link"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id?fields=#get_shared_link"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id?fields=#get_shared_link");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id?fields=#get_shared_link"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id?fields= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id?fields=#get_shared_link")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id?fields=#get_shared_link"))
.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}}/folders/:folder_id?fields=#get_shared_link")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id?fields=#get_shared_link")
.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}}/folders/:folder_id?fields=#get_shared_link');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/folders/:folder_id#get_shared_link',
params: {fields: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link';
const options = {method: 'GET'};
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}}/folders/:folder_id?fields=#get_shared_link',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id?fields=#get_shared_link")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id?fields=',
headers: {}
};
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}}/folders/:folder_id#get_shared_link',
qs: {fields: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id#get_shared_link');
req.query({
fields: ''
});
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}}/folders/:folder_id#get_shared_link',
params: {fields: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id?fields=#get_shared_link"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id?fields=#get_shared_link" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id?fields=#get_shared_link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id#get_shared_link');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'fields' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id#get_shared_link');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id?fields=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id#get_shared_link"
querystring = {"fields":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id#get_shared_link"
queryString <- list(fields = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id?fields=#get_shared_link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id') do |req|
req.params['fields'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id#get_shared_link";
let querystring = [
("fields", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link'
http GET '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link'
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/folders/:folder_id?fields=#get_shared_link'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id?fields=#get_shared_link")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "folder"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link");
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 \"shared_link\": {}\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/folders/:folder_id#remove_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {}}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {}\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}}/folders/:folder_id?fields=#remove_shared_link"),
Content = new StringContent("{\n \"shared_link\": {}\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}}/folders/:folder_id?fields=#remove_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {}\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {}\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/folders/:folder_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 23
{
"shared_link": {}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {}\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {}\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 \"shared_link\": {}\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {}\n}")
.asString();
const data = JSON.stringify({
shared_link: {}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id#remove_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {shared_link: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{}}'
};
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}}/folders/:folder_id?fields=#remove_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {}\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"shared_link\": {}\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link")
.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/folders/:folder_id?fields=',
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({shared_link: {}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id#remove_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {shared_link: {}},
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}}/folders/:folder_id#remove_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {}
});
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}}/folders/:folder_id#remove_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {shared_link: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{}}'
};
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 = @{ @"shared_link": @{ } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link"]
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}}/folders/:folder_id?fields=#remove_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {}\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link",
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([
'shared_link' => [
]
]),
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}}/folders/:folder_id?fields=#remove_shared_link', [
'body' => '{
"shared_link": {}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id#remove_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id#remove_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/folders/:folder_id?fields=#remove_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {}\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/folders/:folder_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id#remove_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id#remove_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {}\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link")
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 \"shared_link\": {}\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/folders/:folder_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {}\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}}/folders/:folder_id#remove_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {}
}'
echo '{
"shared_link": {}
}' | \
http PUT '{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {}\n}' \
--output-document \
- '{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id?fields=#remove_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": null,
"type": "folder"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id?fields=#update_shared_link");
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/folders/:folder_id#update_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {:access ""
:password ""
:permissions {:can_download false
:can_edit false
:can_preview false}
:unshared_at ""
:vanity_name ""}}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id?fields=#update_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/folders/:folder_id?fields=#update_shared_link"),
Content = new StringContent("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/folders/:folder_id?fields=#update_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id?fields=#update_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/folders/:folder_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 218
{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/folders/:folder_id?fields=#update_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id?fields=#update_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id?fields=#update_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/folders/:folder_id?fields=#update_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/folders/:folder_id?fields=#update_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id#update_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id?fields=#update_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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}}/folders/:folder_id?fields=#update_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id?fields=#update_shared_link")
.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/folders/:folder_id?fields=',
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({
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id#update_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
},
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}}/folders/:folder_id#update_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
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}}/folders/:folder_id#update_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id?fields=#update_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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 = @{ @"shared_link": @{ @"access": @"", @"password": @"", @"permissions": @{ @"can_download": @NO, @"can_edit": @NO, @"can_preview": @NO }, @"unshared_at": @"", @"vanity_name": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id?fields=#update_shared_link"]
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}}/folders/:folder_id?fields=#update_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id?fields=#update_shared_link",
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([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]),
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}}/folders/:folder_id?fields=#update_shared_link', [
'body' => '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id#update_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id#update_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/folders/:folder_id?fields=#update_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id?fields=#update_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/folders/:folder_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id#update_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": False,
"can_edit": False,
"can_preview": False
},
"unshared_at": "",
"vanity_name": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id#update_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id?fields=#update_shared_link")
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/folders/:folder_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/folders/:folder_id#update_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({
"access": "",
"password": "",
"permissions": json!({
"can_download": false,
"can_edit": false,
"can_preview": false
}),
"unshared_at": "",
"vanity_name": ""
})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/folders/:folder_id?fields=#update_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
echo '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}' | \
http PUT '{{baseUrl}}/folders/:folder_id?fields=#update_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/folders/:folder_id?fields=#update_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": [
"access": "",
"password": "",
"permissions": [
"can_download": false,
"can_edit": false,
"can_preview": false
],
"unshared_at": "",
"vanity_name": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id?fields=#update_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "folder"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link");
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/web_links/:web_link_id#add_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {:access ""
:password ""
:permissions {:can_download false
:can_edit false
:can_preview false}
:unshared_at ""
:vanity_name ""}}})
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/web_links/:web_link_id?fields=#add_shared_link"),
Content = new StringContent("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/web_links/:web_link_id?fields=#add_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/web_links/:web_link_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 218
{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id#add_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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}}/web_links/:web_link_id?fields=#add_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link")
.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/web_links/:web_link_id?fields=',
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({
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id#add_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
},
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}}/web_links/:web_link_id#add_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
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}}/web_links/:web_link_id#add_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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 = @{ @"shared_link": @{ @"access": @"", @"password": @"", @"permissions": @{ @"can_download": @NO, @"can_edit": @NO, @"can_preview": @NO }, @"unshared_at": @"", @"vanity_name": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link"]
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}}/web_links/:web_link_id?fields=#add_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link",
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([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]),
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}}/web_links/:web_link_id?fields=#add_shared_link', [
'body' => '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id#add_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/web_links/:web_link_id#add_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/web_links/:web_link_id?fields=#add_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/web_links/:web_link_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id#add_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": False,
"can_edit": False,
"can_preview": False
},
"unshared_at": "",
"vanity_name": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id#add_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link")
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/web_links/:web_link_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/web_links/:web_link_id#add_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({
"access": "",
"password": "",
"permissions": json!({
"can_download": false,
"can_edit": false,
"can_preview": false
}),
"unshared_at": "",
"vanity_name": ""
})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
echo '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}' | \
http PUT '{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": [
"access": "",
"password": "",
"permissions": [
"can_download": false,
"can_edit": false,
"can_preview": false
],
"unshared_at": "",
"vanity_name": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id?fields=#add_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "web_link"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shared_items#web_links");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "boxapi: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shared_items#web_links" {:headers {:boxapi ""}})
require "http/client"
url = "{{baseUrl}}/shared_items#web_links"
headers = HTTP::Headers{
"boxapi" => ""
}
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}}/shared_items#web_links"),
Headers =
{
{ "boxapi", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shared_items#web_links");
var request = new RestRequest("", Method.Get);
request.AddHeader("boxapi", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shared_items#web_links"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("boxapi", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shared_items HTTP/1.1
Boxapi:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shared_items#web_links")
.setHeader("boxapi", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shared_items#web_links"))
.header("boxapi", "")
.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}}/shared_items#web_links")
.get()
.addHeader("boxapi", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shared_items#web_links")
.header("boxapi", "")
.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}}/shared_items#web_links');
xhr.setRequestHeader('boxapi', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shared_items#web_links',
headers: {boxapi: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shared_items#web_links';
const options = {method: 'GET', headers: {boxapi: ''}};
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}}/shared_items#web_links',
method: 'GET',
headers: {
boxapi: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shared_items#web_links")
.get()
.addHeader("boxapi", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shared_items',
headers: {
boxapi: ''
}
};
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}}/shared_items#web_links',
headers: {boxapi: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shared_items#web_links');
req.headers({
boxapi: ''
});
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}}/shared_items#web_links',
headers: {boxapi: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shared_items#web_links';
const options = {method: 'GET', headers: {boxapi: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"boxapi": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shared_items#web_links"]
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}}/shared_items#web_links" in
let headers = Header.add (Header.init ()) "boxapi" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shared_items#web_links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"boxapi: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shared_items#web_links', [
'headers' => [
'boxapi' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shared_items#web_links');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'boxapi' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shared_items#web_links');
$request->setRequestMethod('GET');
$request->setHeaders([
'boxapi' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("boxapi", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shared_items#web_links' -Method GET -Headers $headers
$headers=@{}
$headers.Add("boxapi", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shared_items#web_links' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'boxapi': "" }
conn.request("GET", "/baseUrl/shared_items", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shared_items#web_links"
headers = {"boxapi": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shared_items#web_links"
response <- VERB("GET", url, add_headers('boxapi' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shared_items#web_links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["boxapi"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shared_items') do |req|
req.headers['boxapi'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shared_items#web_links";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("boxapi", "".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}}/shared_items#web_links' \
--header 'boxapi: '
http GET '{{baseUrl}}/shared_items#web_links' \
boxapi:''
wget --quiet \
--method GET \
--header 'boxapi: ' \
--output-document \
- '{{baseUrl}}/shared_items#web_links'
import Foundation
let headers = ["boxapi": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shared_items#web_links")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/web_links/:web_link_id#get_shared_link" {:query-params {:fields ""}})
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/web_links/:web_link_id?fields= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link"))
.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}}/web_links/:web_link_id?fields=#get_shared_link")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link")
.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}}/web_links/:web_link_id?fields=#get_shared_link');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/web_links/:web_link_id#get_shared_link',
params: {fields: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link';
const options = {method: 'GET'};
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}}/web_links/:web_link_id?fields=#get_shared_link',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/web_links/:web_link_id?fields=',
headers: {}
};
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}}/web_links/:web_link_id#get_shared_link',
qs: {fields: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/web_links/:web_link_id#get_shared_link');
req.query({
fields: ''
});
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}}/web_links/:web_link_id#get_shared_link',
params: {fields: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/web_links/:web_link_id?fields=#get_shared_link" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link');
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id#get_shared_link');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'fields' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/web_links/:web_link_id#get_shared_link');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/web_links/:web_link_id?fields=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id#get_shared_link"
querystring = {"fields":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id#get_shared_link"
queryString <- list(fields = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/web_links/:web_link_id') do |req|
req.params['fields'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/web_links/:web_link_id#get_shared_link";
let querystring = [
("fields", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link'
http GET '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link'
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id?fields=#get_shared_link")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "web_link"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link");
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 \"shared_link\": {}\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/web_links/:web_link_id#remove_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {}}})
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {}\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}}/web_links/:web_link_id?fields=#remove_shared_link"),
Content = new StringContent("{\n \"shared_link\": {}\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}}/web_links/:web_link_id?fields=#remove_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {}\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {}\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/web_links/:web_link_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 23
{
"shared_link": {}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {}\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {}\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 \"shared_link\": {}\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {}\n}")
.asString();
const data = JSON.stringify({
shared_link: {}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id#remove_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {shared_link: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{}}'
};
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}}/web_links/:web_link_id?fields=#remove_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {}\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"shared_link\": {}\n}")
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link")
.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/web_links/:web_link_id?fields=',
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({shared_link: {}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id#remove_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {shared_link: {}},
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}}/web_links/:web_link_id#remove_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {}
});
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}}/web_links/:web_link_id#remove_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {shared_link: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{}}'
};
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 = @{ @"shared_link": @{ } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link"]
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}}/web_links/:web_link_id?fields=#remove_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {}\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link",
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([
'shared_link' => [
]
]),
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}}/web_links/:web_link_id?fields=#remove_shared_link', [
'body' => '{
"shared_link": {}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id#remove_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/web_links/:web_link_id#remove_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/web_links/:web_link_id?fields=#remove_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {}\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/web_links/:web_link_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id#remove_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id#remove_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {}\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link")
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 \"shared_link\": {}\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/web_links/:web_link_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {}\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}}/web_links/:web_link_id#remove_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {}
}'
echo '{
"shared_link": {}
}' | \
http PUT '{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {}\n}' \
--output-document \
- '{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id?fields=#remove_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": null,
"type": "web_link"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link");
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/web_links/:web_link_id#update_shared_link" {:query-params {:fields ""}
:content-type :json
:form-params {:shared_link {:access ""
:password ""
:permissions {:can_download false
:can_edit false
:can_preview false}
:unshared_at ""
:vanity_name ""}}})
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/web_links/:web_link_id?fields=#update_shared_link"),
Content = new StringContent("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/web_links/:web_link_id?fields=#update_shared_link");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link"
payload := strings.NewReader("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/web_links/:web_link_id?fields= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 218
{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link")
.setHeader("content-type", "application/json")
.setBody("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link")
.header("content-type", "application/json")
.body("{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id#update_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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}}/web_links/:web_link_id?fields=#update_shared_link',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link")
.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/web_links/:web_link_id?fields=',
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({
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id#update_shared_link',
qs: {fields: ''},
headers: {'content-type': 'application/json'},
body: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
},
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}}/web_links/:web_link_id#update_shared_link');
req.query({
fields: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shared_link: {
access: '',
password: '',
permissions: {
can_download: false,
can_edit: false,
can_preview: false
},
unshared_at: '',
vanity_name: ''
}
});
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}}/web_links/:web_link_id#update_shared_link',
params: {fields: ''},
headers: {'content-type': 'application/json'},
data: {
shared_link: {
access: '',
password: '',
permissions: {can_download: false, can_edit: false, can_preview: false},
unshared_at: '',
vanity_name: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"shared_link":{"access":"","password":"","permissions":{"can_download":false,"can_edit":false,"can_preview":false},"unshared_at":"","vanity_name":""}}'
};
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 = @{ @"shared_link": @{ @"access": @"", @"password": @"", @"permissions": @{ @"can_download": @NO, @"can_edit": @NO, @"can_preview": @NO }, @"unshared_at": @"", @"vanity_name": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link"]
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}}/web_links/:web_link_id?fields=#update_shared_link" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link",
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([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]),
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}}/web_links/:web_link_id?fields=#update_shared_link', [
'body' => '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id#update_shared_link');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'fields' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shared_link' => [
'access' => '',
'password' => '',
'permissions' => [
'can_download' => null,
'can_edit' => null,
'can_preview' => null
],
'unshared_at' => '',
'vanity_name' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/web_links/:web_link_id#update_shared_link');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'fields' => ''
]));
$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}}/web_links/:web_link_id?fields=#update_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/web_links/:web_link_id?fields=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id#update_shared_link"
querystring = {"fields":""}
payload = { "shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": False,
"can_edit": False,
"can_preview": False
},
"unshared_at": "",
"vanity_name": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id#update_shared_link"
queryString <- list(fields = "")
payload <- "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link")
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 \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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/web_links/:web_link_id') do |req|
req.params['fields'] = ''
req.body = "{\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"permissions\": {\n \"can_download\": false,\n \"can_edit\": false,\n \"can_preview\": false\n },\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\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}}/web_links/:web_link_id#update_shared_link";
let querystring = [
("fields", ""),
];
let payload = json!({"shared_link": json!({
"access": "",
"password": "",
"permissions": json!({
"can_download": false,
"can_edit": false,
"can_preview": false
}),
"unshared_at": "",
"vanity_name": ""
})});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link' \
--header 'content-type: application/json' \
--data '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}'
echo '{
"shared_link": {
"access": "",
"password": "",
"permissions": {
"can_download": false,
"can_edit": false,
"can_preview": false
},
"unshared_at": "",
"vanity_name": ""
}
}' | \
http PUT '{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "shared_link": {\n "access": "",\n "password": "",\n "permissions": {\n "can_download": false,\n "can_edit": false,\n "can_preview": false\n },\n "unshared_at": "",\n "vanity_name": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shared_link": [
"access": "",
"password": "",
"permissions": [
"can_download": false,
"can_edit": false,
"can_preview": false
],
"unshared_at": "",
"vanity_name": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id?fields=#update_shared_link")! 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
{
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "web_link"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create shield information barrier report
{{baseUrl}}/shield_information_barrier_reports
BODY json
{
"shield_information_barrier": {
"id": "",
"type": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_reports");
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 \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shield_information_barrier_reports" {:content-type :json
:form-params {:shield_information_barrier {:id ""
:type ""}}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_reports"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/shield_information_barrier_reports"),
Content = new StringContent("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/shield_information_barrier_reports");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_reports"
payload := strings.NewReader("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/shield_information_barrier_reports HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 70
{
"shield_information_barrier": {
"id": "",
"type": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shield_information_barrier_reports")
.setHeader("content-type", "application/json")
.setBody("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_reports"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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 \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_reports")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shield_information_barrier_reports")
.header("content-type", "application/json")
.body("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
shield_information_barrier: {
id: '',
type: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shield_information_barrier_reports');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_reports',
headers: {'content-type': 'application/json'},
data: {shield_information_barrier: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"shield_information_barrier":{"id":"","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}}/shield_information_barrier_reports',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shield_information_barrier": {\n "id": "",\n "type": ""\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 \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_reports")
.post(body)
.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/shield_information_barrier_reports',
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({shield_information_barrier: {id: '', type: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_reports',
headers: {'content-type': 'application/json'},
body: {shield_information_barrier: {id: '', type: ''}},
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}}/shield_information_barrier_reports');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shield_information_barrier: {
id: '',
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: 'POST',
url: '{{baseUrl}}/shield_information_barrier_reports',
headers: {'content-type': 'application/json'},
data: {shield_information_barrier: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"shield_information_barrier":{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"shield_information_barrier": @{ @"id": @"", @"type": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_reports"]
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}}/shield_information_barrier_reports" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_reports",
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([
'shield_information_barrier' => [
'id' => '',
'type' => ''
]
]),
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('POST', '{{baseUrl}}/shield_information_barrier_reports', [
'body' => '{
"shield_information_barrier": {
"id": "",
"type": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_reports');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shield_information_barrier' => [
'id' => '',
'type' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shield_information_barrier' => [
'id' => '',
'type' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/shield_information_barrier_reports');
$request->setRequestMethod('POST');
$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}}/shield_information_barrier_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"shield_information_barrier": {
"id": "",
"type": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"shield_information_barrier": {
"id": "",
"type": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shield_information_barrier_reports", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_reports"
payload = { "shield_information_barrier": {
"id": "",
"type": ""
} }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_reports"
payload <- "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/shield_information_barrier_reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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/shield_information_barrier_reports') do |req|
req.body = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_reports";
let payload = json!({"shield_information_barrier": json!({
"id": "",
"type": ""
})});
let mut headers = reqwest::header::HeaderMap::new();
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}}/shield_information_barrier_reports \
--header 'content-type: application/json' \
--data '{
"shield_information_barrier": {
"id": "",
"type": ""
}
}'
echo '{
"shield_information_barrier": {
"id": "",
"type": ""
}
}' | \
http POST {{baseUrl}}/shield_information_barrier_reports \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "shield_information_barrier": {\n "id": "",\n "type": ""\n }\n}' \
--output-document \
- {{baseUrl}}/shield_information_barrier_reports
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["shield_information_barrier": [
"id": "",
"type": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_reports")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get shield information barrier report by ID
{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id
QUERY PARAMS
shield_information_barrier_report_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_reports/:shield_information_barrier_report_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id"))
.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}}/shield_information_barrier_reports/:shield_information_barrier_report_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id")
.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}}/shield_information_barrier_reports/:shield_information_barrier_report_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id';
const options = {method: 'GET'};
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}}/shield_information_barrier_reports/:shield_information_barrier_report_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_reports/:shield_information_barrier_report_id',
headers: {}
};
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}}/shield_information_barrier_reports/:shield_information_barrier_report_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id');
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}}/shield_information_barrier_reports/:shield_information_barrier_report_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_reports/:shield_information_barrier_report_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_reports/:shield_information_barrier_report_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_reports/:shield_information_barrier_report_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id
http GET {{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_reports/:shield_information_barrier_report_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List shield information barrier reports
{{baseUrl}}/shield_information_barrier_reports
QUERY PARAMS
shield_information_barrier_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_reports" {:query-params {:shield_information_barrier_id ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_reports?shield_information_barrier_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id="))
.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}}/shield_information_barrier_reports?shield_information_barrier_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=")
.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}}/shield_information_barrier_reports?shield_information_barrier_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_reports',
params: {shield_information_barrier_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=';
const options = {method: 'GET'};
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}}/shield_information_barrier_reports?shield_information_barrier_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_reports?shield_information_barrier_id=',
headers: {}
};
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}}/shield_information_barrier_reports',
qs: {shield_information_barrier_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_reports');
req.query({
shield_information_barrier_id: ''
});
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}}/shield_information_barrier_reports',
params: {shield_information_barrier_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_reports?shield_information_barrier_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_reports');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'shield_information_barrier_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_reports');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'shield_information_barrier_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_reports?shield_information_barrier_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_reports"
querystring = {"shield_information_barrier_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_reports"
queryString <- list(shield_information_barrier_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_reports') do |req|
req.params['shield_information_barrier_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_reports";
let querystring = [
("shield_information_barrier_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id='
http GET '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_reports?shield_information_barrier_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create shield information barrier segment member
{{baseUrl}}/shield_information_barrier_segment_members
BODY json
{
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_members");
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 \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shield_information_barrier_segment_members" {:content-type :json
:form-params {:shield_information_barrier {:id ""
:type ""}
:shield_information_barrier_segment {:id ""
:type ""}
:type ""
:user ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_members"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\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}}/shield_information_barrier_segment_members"),
Content = new StringContent("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\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}}/shield_information_barrier_segment_members");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_members"
payload := strings.NewReader("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/shield_information_barrier_segment_members HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 174
{
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shield_information_barrier_segment_members")
.setHeader("content-type", "application/json")
.setBody("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_members"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\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 \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_members")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shield_information_barrier_segment_members")
.header("content-type", "application/json")
.body("{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}")
.asString();
const data = JSON.stringify({
shield_information_barrier: {
id: '',
type: ''
},
shield_information_barrier_segment: {
id: '',
type: ''
},
type: '',
user: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shield_information_barrier_segment_members');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segment_members',
headers: {'content-type': 'application/json'},
data: {
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: '',
user: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_members';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"shield_information_barrier":{"id":"","type":""},"shield_information_barrier_segment":{"id":"","type":""},"type":"","user":""}'
};
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}}/shield_information_barrier_segment_members',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "shield_information_barrier": {\n "id": "",\n "type": ""\n },\n "shield_information_barrier_segment": {\n "id": "",\n "type": ""\n },\n "type": "",\n "user": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_members")
.post(body)
.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/shield_information_barrier_segment_members',
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({
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: '',
user: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segment_members',
headers: {'content-type': 'application/json'},
body: {
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: '',
user: ''
},
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}}/shield_information_barrier_segment_members');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
shield_information_barrier: {
id: '',
type: ''
},
shield_information_barrier_segment: {
id: '',
type: ''
},
type: '',
user: ''
});
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}}/shield_information_barrier_segment_members',
headers: {'content-type': 'application/json'},
data: {
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: '',
user: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_members';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"shield_information_barrier":{"id":"","type":""},"shield_information_barrier_segment":{"id":"","type":""},"type":"","user":""}'
};
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 = @{ @"shield_information_barrier": @{ @"id": @"", @"type": @"" },
@"shield_information_barrier_segment": @{ @"id": @"", @"type": @"" },
@"type": @"",
@"user": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_members"]
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}}/shield_information_barrier_segment_members" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_members",
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([
'shield_information_barrier' => [
'id' => '',
'type' => ''
],
'shield_information_barrier_segment' => [
'id' => '',
'type' => ''
],
'type' => '',
'user' => ''
]),
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('POST', '{{baseUrl}}/shield_information_barrier_segment_members', [
'body' => '{
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_members');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'shield_information_barrier' => [
'id' => '',
'type' => ''
],
'shield_information_barrier_segment' => [
'id' => '',
'type' => ''
],
'type' => '',
'user' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'shield_information_barrier' => [
'id' => '',
'type' => ''
],
'shield_information_barrier_segment' => [
'id' => '',
'type' => ''
],
'type' => '',
'user' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_members');
$request->setRequestMethod('POST');
$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}}/shield_information_barrier_segment_members' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_members' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shield_information_barrier_segment_members", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_members"
payload = {
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_members"
payload <- "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\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}}/shield_information_barrier_segment_members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\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/shield_information_barrier_segment_members') do |req|
req.body = "{\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\",\n \"user\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_members";
let payload = json!({
"shield_information_barrier": json!({
"id": "",
"type": ""
}),
"shield_information_barrier_segment": json!({
"id": "",
"type": ""
}),
"type": "",
"user": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/shield_information_barrier_segment_members \
--header 'content-type: application/json' \
--data '{
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}'
echo '{
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": "",
"user": ""
}' | \
http POST {{baseUrl}}/shield_information_barrier_segment_members \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "shield_information_barrier": {\n "id": "",\n "type": ""\n },\n "shield_information_barrier_segment": {\n "id": "",\n "type": ""\n },\n "type": "",\n "user": ""\n}' \
--output-document \
- {{baseUrl}}/shield_information_barrier_segment_members
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"shield_information_barrier": [
"id": "",
"type": ""
],
"shield_information_barrier_segment": [
"id": "",
"type": ""
],
"type": "",
"user": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_members")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete shield information barrier segment member by ID
{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
QUERY PARAMS
shield_information_barrier_segment_member_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"))
.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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id';
const options = {method: 'DELETE'};
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id',
headers: {}
};
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
http DELETE {{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get shield information barrier segment member by ID
{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
QUERY PARAMS
shield_information_barrier_segment_member_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"))
.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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id';
const options = {method: 'GET'};
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id',
headers: {}
};
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
http GET {{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List shield information barrier segment members
{{baseUrl}}/shield_information_barrier_segment_members
QUERY PARAMS
shield_information_barrier_segment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_segment_members" {:query-params {:shield_information_barrier_segment_id ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_segment_members?shield_information_barrier_segment_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id="))
.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}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=")
.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}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_segment_members',
params: {shield_information_barrier_segment_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=';
const options = {method: 'GET'};
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}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segment_members?shield_information_barrier_segment_id=',
headers: {}
};
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}}/shield_information_barrier_segment_members',
qs: {shield_information_barrier_segment_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_segment_members');
req.query({
shield_information_barrier_segment_id: ''
});
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}}/shield_information_barrier_segment_members',
params: {shield_information_barrier_segment_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_members');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'shield_information_barrier_segment_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_members');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'shield_information_barrier_segment_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_segment_members?shield_information_barrier_segment_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_members"
querystring = {"shield_information_barrier_segment_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_members"
queryString <- list(shield_information_barrier_segment_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_segment_members') do |req|
req.params['shield_information_barrier_segment_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_members";
let querystring = [
("shield_information_barrier_segment_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id='
http GET '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_members?shield_information_barrier_segment_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create shield information barrier segment restriction
{{baseUrl}}/shield_information_barrier_segment_restrictions
BODY json
{
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_restrictions");
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 \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shield_information_barrier_segment_restrictions" {:content-type :json
:form-params {:restricted_segment {:id ""
:type ""}
:shield_information_barrier {:id ""
:type ""}
:shield_information_barrier_segment {:id ""
:type ""}
:type ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\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}}/shield_information_barrier_segment_restrictions"),
Content = new StringContent("{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\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}}/shield_information_barrier_segment_restrictions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_restrictions"
payload := strings.NewReader("{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/shield_information_barrier_segment_restrictions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 220
{
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shield_information_barrier_segment_restrictions")
.setHeader("content-type", "application/json")
.setBody("{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_restrictions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\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 \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_restrictions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shield_information_barrier_segment_restrictions")
.header("content-type", "application/json")
.body("{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}")
.asString();
const data = JSON.stringify({
restricted_segment: {
id: '',
type: ''
},
shield_information_barrier: {
id: '',
type: ''
},
shield_information_barrier_segment: {
id: '',
type: ''
},
type: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shield_information_barrier_segment_restrictions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segment_restrictions',
headers: {'content-type': 'application/json'},
data: {
restricted_segment: {id: '', type: ''},
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"restricted_segment":{"id":"","type":""},"shield_information_barrier":{"id":"","type":""},"shield_information_barrier_segment":{"id":"","type":""},"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}}/shield_information_barrier_segment_restrictions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "restricted_segment": {\n "id": "",\n "type": ""\n },\n "shield_information_barrier": {\n "id": "",\n "type": ""\n },\n "shield_information_barrier_segment": {\n "id": "",\n "type": ""\n },\n "type": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_restrictions")
.post(body)
.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/shield_information_barrier_segment_restrictions',
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({
restricted_segment: {id: '', type: ''},
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segment_restrictions',
headers: {'content-type': 'application/json'},
body: {
restricted_segment: {id: '', type: ''},
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: ''
},
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}}/shield_information_barrier_segment_restrictions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
restricted_segment: {
id: '',
type: ''
},
shield_information_barrier: {
id: '',
type: ''
},
shield_information_barrier_segment: {
id: '',
type: ''
},
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: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segment_restrictions',
headers: {'content-type': 'application/json'},
data: {
restricted_segment: {id: '', type: ''},
shield_information_barrier: {id: '', type: ''},
shield_information_barrier_segment: {id: '', type: ''},
type: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"restricted_segment":{"id":"","type":""},"shield_information_barrier":{"id":"","type":""},"shield_information_barrier_segment":{"id":"","type":""},"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": @"application/json" };
NSDictionary *parameters = @{ @"restricted_segment": @{ @"id": @"", @"type": @"" },
@"shield_information_barrier": @{ @"id": @"", @"type": @"" },
@"shield_information_barrier_segment": @{ @"id": @"", @"type": @"" },
@"type": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_restrictions"]
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}}/shield_information_barrier_segment_restrictions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_restrictions",
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([
'restricted_segment' => [
'id' => '',
'type' => ''
],
'shield_information_barrier' => [
'id' => '',
'type' => ''
],
'shield_information_barrier_segment' => [
'id' => '',
'type' => ''
],
'type' => ''
]),
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('POST', '{{baseUrl}}/shield_information_barrier_segment_restrictions', [
'body' => '{
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'restricted_segment' => [
'id' => '',
'type' => ''
],
'shield_information_barrier' => [
'id' => '',
'type' => ''
],
'shield_information_barrier_segment' => [
'id' => '',
'type' => ''
],
'type' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'restricted_segment' => [
'id' => '',
'type' => ''
],
'shield_information_barrier' => [
'id' => '',
'type' => ''
],
'shield_information_barrier_segment' => [
'id' => '',
'type' => ''
],
'type' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions');
$request->setRequestMethod('POST');
$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}}/shield_information_barrier_segment_restrictions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_restrictions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shield_information_barrier_segment_restrictions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions"
payload = {
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_restrictions"
payload <- "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\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}}/shield_information_barrier_segment_restrictions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\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/shield_information_barrier_segment_restrictions') do |req|
req.body = "{\n \"restricted_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"shield_information_barrier_segment\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_restrictions";
let payload = json!({
"restricted_segment": json!({
"id": "",
"type": ""
}),
"shield_information_barrier": json!({
"id": "",
"type": ""
}),
"shield_information_barrier_segment": json!({
"id": "",
"type": ""
}),
"type": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/shield_information_barrier_segment_restrictions \
--header 'content-type: application/json' \
--data '{
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}'
echo '{
"restricted_segment": {
"id": "",
"type": ""
},
"shield_information_barrier": {
"id": "",
"type": ""
},
"shield_information_barrier_segment": {
"id": "",
"type": ""
},
"type": ""
}' | \
http POST {{baseUrl}}/shield_information_barrier_segment_restrictions \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "restricted_segment": {\n "id": "",\n "type": ""\n },\n "shield_information_barrier": {\n "id": "",\n "type": ""\n },\n "shield_information_barrier_segment": {\n "id": "",\n "type": ""\n },\n "type": ""\n}' \
--output-document \
- {{baseUrl}}/shield_information_barrier_segment_restrictions
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"restricted_segment": [
"id": "",
"type": ""
],
"shield_information_barrier": [
"id": "",
"type": ""
],
"shield_information_barrier_segment": [
"id": "",
"type": ""
],
"type": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_restrictions")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete shield information barrier segment restriction by ID
{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
QUERY PARAMS
shield_information_barrier_segment_restriction_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"))
.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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id';
const options = {method: 'DELETE'};
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id',
headers: {}
};
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
http DELETE {{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get shield information barrier segment restriction by ID
{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
QUERY PARAMS
shield_information_barrier_segment_restriction_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"))
.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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id';
const options = {method: 'GET'};
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id',
headers: {}
};
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
http GET {{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List shield information barrier segment restrictions
{{baseUrl}}/shield_information_barrier_segment_restrictions
QUERY PARAMS
shield_information_barrier_segment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_segment_restrictions" {:query-params {:shield_information_barrier_segment_id ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id="))
.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}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=")
.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}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_segment_restrictions',
params: {shield_information_barrier_segment_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=';
const options = {method: 'GET'};
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}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=',
headers: {}
};
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}}/shield_information_barrier_segment_restrictions',
qs: {shield_information_barrier_segment_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_segment_restrictions');
req.query({
shield_information_barrier_segment_id: ''
});
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}}/shield_information_barrier_segment_restrictions',
params: {shield_information_barrier_segment_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'shield_information_barrier_segment_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segment_restrictions');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'shield_information_barrier_segment_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segment_restrictions"
querystring = {"shield_information_barrier_segment_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segment_restrictions"
queryString <- list(shield_information_barrier_segment_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_segment_restrictions') do |req|
req.params['shield_information_barrier_segment_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segment_restrictions";
let querystring = [
("shield_information_barrier_segment_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id='
http GET '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create shield information barrier segment
{{baseUrl}}/shield_information_barrier_segments
BODY json
{
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segments");
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 \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shield_information_barrier_segments" {:content-type :json
:form-params {:description ""
:name ""
:shield_information_barrier {:id ""
:type ""}}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/shield_information_barrier_segments"),
Content = new StringContent("{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/shield_information_barrier_segments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segments"
payload := strings.NewReader("{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/shield_information_barrier_segments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 105
{
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shield_information_barrier_segments")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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 \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shield_information_barrier_segments")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
description: '',
name: '',
shield_information_barrier: {
id: '',
type: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shield_information_barrier_segments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segments',
headers: {'content-type': 'application/json'},
data: {description: '', name: '', shield_information_barrier: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","shield_information_barrier":{"id":"","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}}/shield_information_barrier_segments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "name": "",\n "shield_information_barrier": {\n "id": "",\n "type": ""\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 \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segments")
.post(body)
.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/shield_information_barrier_segments',
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({description: '', name: '', shield_information_barrier: {id: '', type: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segments',
headers: {'content-type': 'application/json'},
body: {description: '', name: '', shield_information_barrier: {id: '', type: ''}},
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}}/shield_information_barrier_segments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
name: '',
shield_information_barrier: {
id: '',
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: 'POST',
url: '{{baseUrl}}/shield_information_barrier_segments',
headers: {'content-type': 'application/json'},
data: {description: '', name: '', shield_information_barrier: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","shield_information_barrier":{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"description": @"",
@"name": @"",
@"shield_information_barrier": @{ @"id": @"", @"type": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segments"]
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}}/shield_information_barrier_segments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segments",
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([
'description' => '',
'name' => '',
'shield_information_barrier' => [
'id' => '',
'type' => ''
]
]),
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('POST', '{{baseUrl}}/shield_information_barrier_segments', [
'body' => '{
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'name' => '',
'shield_information_barrier' => [
'id' => '',
'type' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'name' => '',
'shield_information_barrier' => [
'id' => '',
'type' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/shield_information_barrier_segments');
$request->setRequestMethod('POST');
$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}}/shield_information_barrier_segments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shield_information_barrier_segments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segments"
payload = {
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segments"
payload <- "{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/shield_information_barrier_segments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\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/shield_information_barrier_segments') do |req|
req.body = "{\n \"description\": \"\",\n \"name\": \"\",\n \"shield_information_barrier\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segments";
let payload = json!({
"description": "",
"name": "",
"shield_information_barrier": json!({
"id": "",
"type": ""
})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/shield_information_barrier_segments \
--header 'content-type: application/json' \
--data '{
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}'
echo '{
"description": "",
"name": "",
"shield_information_barrier": {
"id": "",
"type": ""
}
}' | \
http POST {{baseUrl}}/shield_information_barrier_segments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "name": "",\n "shield_information_barrier": {\n "id": "",\n "type": ""\n }\n}' \
--output-document \
- {{baseUrl}}/shield_information_barrier_segments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"name": "",
"shield_information_barrier": [
"id": "",
"type": ""
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segments")! 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
{
"created_at": "2020-06-26T18:44:45.869Z",
"description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
"id": "11446498",
"name": "Investment Banking",
"shield_information_barrier": {
"id": "11446498",
"type": "shield_information_barrier"
},
"type": "shield_information_barrier_segment",
"updated_at": "2020-07-26T18:44:45.869Z"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete shield information barrier segment
{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
QUERY PARAMS
shield_information_barrier_segment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"))
.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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id';
const options = {method: 'DELETE'};
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id',
headers: {}
};
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
http DELETE {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get shield information barrier segment with specified ID
{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
QUERY PARAMS
shield_information_barrier_segment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"))
.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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id';
const options = {method: 'GET'};
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id',
headers: {}
};
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
http GET {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2020-06-26T18:44:45.869Z",
"description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
"id": "11446498",
"name": "Investment Banking",
"shield_information_barrier": {
"id": "11446498",
"type": "shield_information_barrier"
},
"type": "shield_information_barrier_segment",
"updated_at": "2020-07-26T18:44:45.869Z"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List shield information barrier segments
{{baseUrl}}/shield_information_barrier_segments
QUERY PARAMS
shield_information_barrier_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barrier_segments" {:query-params {:shield_information_barrier_id ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barrier_segments?shield_information_barrier_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id="))
.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}}/shield_information_barrier_segments?shield_information_barrier_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=")
.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}}/shield_information_barrier_segments?shield_information_barrier_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barrier_segments',
params: {shield_information_barrier_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=';
const options = {method: 'GET'};
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}}/shield_information_barrier_segments?shield_information_barrier_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barrier_segments?shield_information_barrier_id=',
headers: {}
};
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}}/shield_information_barrier_segments',
qs: {shield_information_barrier_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barrier_segments');
req.query({
shield_information_barrier_id: ''
});
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}}/shield_information_barrier_segments',
params: {shield_information_barrier_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barrier_segments?shield_information_barrier_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segments');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'shield_information_barrier_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barrier_segments');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'shield_information_barrier_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barrier_segments?shield_information_barrier_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segments"
querystring = {"shield_information_barrier_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segments"
queryString <- list(shield_information_barrier_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barrier_segments') do |req|
req.params['shield_information_barrier_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barrier_segments";
let querystring = [
("shield_information_barrier_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id='
http GET '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segments?shield_information_barrier_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update shield information barrier segment with specified ID
{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
QUERY PARAMS
shield_information_barrier_segment_id
BODY json
{
"description": "",
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id");
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 \"description\": \"\",\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id" {:content-type :json
:form-params {:description ""
:name ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"name\": \"\"\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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"),
Content = new StringContent("{\n \"description\": \"\",\n \"name\": \"\"\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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
payload := strings.NewReader("{\n \"description\": \"\",\n \"name\": \"\"\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/shield_information_barrier_segments/:shield_information_barrier_segment_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 37
{
"description": "",
"name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"name\": \"\"\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 \"description\": \"\",\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"name\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id',
headers: {'content-type': 'application/json'},
data: {description: '', name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":""}'
};
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
.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/shield_information_barrier_segments/:shield_information_barrier_segment_id',
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({description: '', name: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id',
headers: {'content-type': 'application/json'},
body: {description: '', name: ''},
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
name: ''
});
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id',
headers: {'content-type': 'application/json'},
data: {description: '', name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":""}'
};
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 = @{ @"description": @"",
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"name\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_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([
'description' => '',
'name' => ''
]),
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id', [
'body' => '{
"description": "",
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id');
$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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/shield_information_barrier_segments/:shield_information_barrier_segment_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
payload = {
"description": "",
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id"
payload <- "{\n \"description\": \"\",\n \"name\": \"\"\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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id")
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 \"description\": \"\",\n \"name\": \"\"\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/shield_information_barrier_segments/:shield_information_barrier_segment_id') do |req|
req.body = "{\n \"description\": \"\",\n \"name\": \"\"\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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id";
let payload = json!({
"description": "",
"name": ""
});
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}}/shield_information_barrier_segments/:shield_information_barrier_segment_id \
--header 'content-type: application/json' \
--data '{
"description": "",
"name": ""
}'
echo '{
"description": "",
"name": ""
}' | \
http PUT {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barrier_segments/:shield_information_barrier_segment_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
{
"created_at": "2020-06-26T18:44:45.869Z",
"description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
"id": "11446498",
"name": "Investment Banking",
"shield_information_barrier": {
"id": "11446498",
"type": "shield_information_barrier"
},
"type": "shield_information_barrier_segment",
"updated_at": "2020-07-26T18:44:45.869Z"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Add changed status of shield information barrier with specified ID
{{baseUrl}}/shield_information_barriers/change_status
BODY json
{
"id": "",
"status": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barriers/change_status");
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 \"id\": \"\",\n \"status\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shield_information_barriers/change_status" {:content-type :json
:form-params {:id ""
:status ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barriers/change_status"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"id\": \"\",\n \"status\": \"\"\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}}/shield_information_barriers/change_status"),
Content = new StringContent("{\n \"id\": \"\",\n \"status\": \"\"\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}}/shield_information_barriers/change_status");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"id\": \"\",\n \"status\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barriers/change_status"
payload := strings.NewReader("{\n \"id\": \"\",\n \"status\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/shield_information_barriers/change_status HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 30
{
"id": "",
"status": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shield_information_barriers/change_status")
.setHeader("content-type", "application/json")
.setBody("{\n \"id\": \"\",\n \"status\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barriers/change_status"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"id\": \"\",\n \"status\": \"\"\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 \"id\": \"\",\n \"status\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shield_information_barriers/change_status")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shield_information_barriers/change_status")
.header("content-type", "application/json")
.body("{\n \"id\": \"\",\n \"status\": \"\"\n}")
.asString();
const data = JSON.stringify({
id: '',
status: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shield_information_barriers/change_status');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barriers/change_status',
headers: {'content-type': 'application/json'},
data: {id: '', status: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barriers/change_status';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"id":"","status":""}'
};
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}}/shield_information_barriers/change_status',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "id": "",\n "status": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"id\": \"\",\n \"status\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barriers/change_status")
.post(body)
.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/shield_information_barriers/change_status',
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({id: '', status: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barriers/change_status',
headers: {'content-type': 'application/json'},
body: {id: '', status: ''},
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}}/shield_information_barriers/change_status');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
id: '',
status: ''
});
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}}/shield_information_barriers/change_status',
headers: {'content-type': 'application/json'},
data: {id: '', status: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barriers/change_status';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"id":"","status":""}'
};
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 = @{ @"id": @"",
@"status": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barriers/change_status"]
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}}/shield_information_barriers/change_status" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"id\": \"\",\n \"status\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barriers/change_status",
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([
'id' => '',
'status' => ''
]),
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('POST', '{{baseUrl}}/shield_information_barriers/change_status', [
'body' => '{
"id": "",
"status": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barriers/change_status');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'id' => '',
'status' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'id' => '',
'status' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shield_information_barriers/change_status');
$request->setRequestMethod('POST');
$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}}/shield_information_barriers/change_status' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"id": "",
"status": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barriers/change_status' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"id": "",
"status": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"id\": \"\",\n \"status\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shield_information_barriers/change_status", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barriers/change_status"
payload = {
"id": "",
"status": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barriers/change_status"
payload <- "{\n \"id\": \"\",\n \"status\": \"\"\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}}/shield_information_barriers/change_status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"id\": \"\",\n \"status\": \"\"\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/shield_information_barriers/change_status') do |req|
req.body = "{\n \"id\": \"\",\n \"status\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barriers/change_status";
let payload = json!({
"id": "",
"status": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/shield_information_barriers/change_status \
--header 'content-type: application/json' \
--data '{
"id": "",
"status": ""
}'
echo '{
"id": "",
"status": ""
}' | \
http POST {{baseUrl}}/shield_information_barriers/change_status \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "id": "",\n "status": ""\n}' \
--output-document \
- {{baseUrl}}/shield_information_barriers/change_status
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"id": "",
"status": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barriers/change_status")! 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
{
"created_at": "2020-06-26T18:44:45.869Z",
"enabled_at": "2020-07-26T18:44:45.869Z",
"id": "11446498",
"status": "draft",
"type": "shield_information_barrier",
"updated_at": "2020-07-26T18:44:45.869Z"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create shield information barrier
{{baseUrl}}/shield_information_barriers
BODY json
{
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barriers");
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 \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shield_information_barriers" {:content-type :json
:form-params {:created_at ""
:created_by ""
:enabled_at ""
:enabled_by ""
:enterprise ""
:id ""
:status ""
:type ""
:updated_at ""
:updated_by ""}})
require "http/client"
url = "{{baseUrl}}/shield_information_barriers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\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}}/shield_information_barriers"),
Content = new StringContent("{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\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}}/shield_information_barriers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barriers"
payload := strings.NewReader("{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/shield_information_barriers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 184
{
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shield_information_barriers")
.setHeader("content-type", "application/json")
.setBody("{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barriers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\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 \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shield_information_barriers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shield_information_barriers")
.header("content-type", "application/json")
.body("{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}")
.asString();
const data = JSON.stringify({
created_at: '',
created_by: '',
enabled_at: '',
enabled_by: '',
enterprise: '',
id: '',
status: '',
type: '',
updated_at: '',
updated_by: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shield_information_barriers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barriers',
headers: {'content-type': 'application/json'},
data: {
created_at: '',
created_by: '',
enabled_at: '',
enabled_by: '',
enterprise: '',
id: '',
status: '',
type: '',
updated_at: '',
updated_by: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barriers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"created_at":"","created_by":"","enabled_at":"","enabled_by":"","enterprise":"","id":"","status":"","type":"","updated_at":"","updated_by":""}'
};
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}}/shield_information_barriers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "created_at": "",\n "created_by": "",\n "enabled_at": "",\n "enabled_by": "",\n "enterprise": "",\n "id": "",\n "status": "",\n "type": "",\n "updated_at": "",\n "updated_by": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barriers")
.post(body)
.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/shield_information_barriers',
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({
created_at: '',
created_by: '',
enabled_at: '',
enabled_by: '',
enterprise: '',
id: '',
status: '',
type: '',
updated_at: '',
updated_by: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shield_information_barriers',
headers: {'content-type': 'application/json'},
body: {
created_at: '',
created_by: '',
enabled_at: '',
enabled_by: '',
enterprise: '',
id: '',
status: '',
type: '',
updated_at: '',
updated_by: ''
},
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}}/shield_information_barriers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
created_at: '',
created_by: '',
enabled_at: '',
enabled_by: '',
enterprise: '',
id: '',
status: '',
type: '',
updated_at: '',
updated_by: ''
});
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}}/shield_information_barriers',
headers: {'content-type': 'application/json'},
data: {
created_at: '',
created_by: '',
enabled_at: '',
enabled_by: '',
enterprise: '',
id: '',
status: '',
type: '',
updated_at: '',
updated_by: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barriers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"created_at":"","created_by":"","enabled_at":"","enabled_by":"","enterprise":"","id":"","status":"","type":"","updated_at":"","updated_by":""}'
};
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 = @{ @"created_at": @"",
@"created_by": @"",
@"enabled_at": @"",
@"enabled_by": @"",
@"enterprise": @"",
@"id": @"",
@"status": @"",
@"type": @"",
@"updated_at": @"",
@"updated_by": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barriers"]
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}}/shield_information_barriers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barriers",
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([
'created_at' => '',
'created_by' => '',
'enabled_at' => '',
'enabled_by' => '',
'enterprise' => '',
'id' => '',
'status' => '',
'type' => '',
'updated_at' => '',
'updated_by' => ''
]),
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('POST', '{{baseUrl}}/shield_information_barriers', [
'body' => '{
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barriers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'created_at' => '',
'created_by' => '',
'enabled_at' => '',
'enabled_by' => '',
'enterprise' => '',
'id' => '',
'status' => '',
'type' => '',
'updated_at' => '',
'updated_by' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'created_at' => '',
'created_by' => '',
'enabled_at' => '',
'enabled_by' => '',
'enterprise' => '',
'id' => '',
'status' => '',
'type' => '',
'updated_at' => '',
'updated_by' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shield_information_barriers');
$request->setRequestMethod('POST');
$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}}/shield_information_barriers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barriers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shield_information_barriers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barriers"
payload = {
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barriers"
payload <- "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\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}}/shield_information_barriers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\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/shield_information_barriers') do |req|
req.body = "{\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\",\n \"enterprise\": \"\",\n \"id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barriers";
let payload = json!({
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/shield_information_barriers \
--header 'content-type: application/json' \
--data '{
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}'
echo '{
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
}' | \
http POST {{baseUrl}}/shield_information_barriers \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "created_at": "",\n "created_by": "",\n "enabled_at": "",\n "enabled_by": "",\n "enterprise": "",\n "id": "",\n "status": "",\n "type": "",\n "updated_at": "",\n "updated_by": ""\n}' \
--output-document \
- {{baseUrl}}/shield_information_barriers
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"created_at": "",
"created_by": "",
"enabled_at": "",
"enabled_by": "",
"enterprise": "",
"id": "",
"status": "",
"type": "",
"updated_at": "",
"updated_by": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barriers")! 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
{
"created_at": "2020-06-26T18:44:45.869Z",
"enabled_at": "2020-07-26T18:44:45.869Z",
"id": "11446498",
"status": "draft",
"type": "shield_information_barrier",
"updated_at": "2020-07-26T18:44:45.869Z"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get shield information barrier with specified ID
{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id
QUERY PARAMS
shield_information_barrier_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id")
require "http/client"
url = "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barriers/:shield_information_barrier_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id"))
.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}}/shield_information_barriers/:shield_information_barrier_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id")
.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}}/shield_information_barriers/:shield_information_barrier_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id';
const options = {method: 'GET'};
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}}/shield_information_barriers/:shield_information_barrier_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barriers/:shield_information_barrier_id',
headers: {}
};
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}}/shield_information_barriers/:shield_information_barrier_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id');
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}}/shield_information_barriers/:shield_information_barrier_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barriers/:shield_information_barrier_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barriers/:shield_information_barrier_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barriers/:shield_information_barrier_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shield_information_barriers/:shield_information_barrier_id
http GET {{baseUrl}}/shield_information_barriers/:shield_information_barrier_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shield_information_barriers/:shield_information_barrier_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barriers/:shield_information_barrier_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2020-06-26T18:44:45.869Z",
"enabled_at": "2020-07-26T18:44:45.869Z",
"id": "11446498",
"status": "draft",
"type": "shield_information_barrier",
"updated_at": "2020-07-26T18:44:45.869Z"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List shield information barriers
{{baseUrl}}/shield_information_barriers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shield_information_barriers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shield_information_barriers")
require "http/client"
url = "{{baseUrl}}/shield_information_barriers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shield_information_barriers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shield_information_barriers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shield_information_barriers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shield_information_barriers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shield_information_barriers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shield_information_barriers"))
.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}}/shield_information_barriers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shield_information_barriers")
.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}}/shield_information_barriers');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shield_information_barriers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shield_information_barriers';
const options = {method: 'GET'};
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}}/shield_information_barriers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shield_information_barriers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shield_information_barriers',
headers: {}
};
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}}/shield_information_barriers'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shield_information_barriers');
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}}/shield_information_barriers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shield_information_barriers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shield_information_barriers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shield_information_barriers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shield_information_barriers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/shield_information_barriers');
echo $response->getBody();
setUrl('{{baseUrl}}/shield_information_barriers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shield_information_barriers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shield_information_barriers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shield_information_barriers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shield_information_barriers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shield_information_barriers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shield_information_barriers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shield_information_barriers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shield_information_barriers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shield_information_barriers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shield_information_barriers
http GET {{baseUrl}}/shield_information_barriers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shield_information_barriers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shield_information_barriers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create Box Skill cards on file
{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
QUERY PARAMS
file_id
BODY json
{
"cards": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards");
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 \"cards\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards" {:content-type :json
:form-params {:cards []}})
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"cards\": []\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}}/files/:file_id/metadata/global/boxSkillsCards"),
Content = new StringContent("{\n \"cards\": []\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}}/files/:file_id/metadata/global/boxSkillsCards");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"cards\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
payload := strings.NewReader("{\n \"cards\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id/metadata/global/boxSkillsCards HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"cards": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.setHeader("content-type", "application/json")
.setBody("{\n \"cards\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"cards\": []\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 \"cards\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.header("content-type", "application/json")
.body("{\n \"cards\": []\n}")
.asString();
const data = JSON.stringify({
cards: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards',
headers: {'content-type': 'application/json'},
data: {cards: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"cards":[]}'
};
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}}/files/:file_id/metadata/global/boxSkillsCards',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "cards": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"cards\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.post(body)
.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/files/:file_id/metadata/global/boxSkillsCards',
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({cards: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards',
headers: {'content-type': 'application/json'},
body: {cards: []},
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}}/files/:file_id/metadata/global/boxSkillsCards');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
cards: []
});
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}}/files/:file_id/metadata/global/boxSkillsCards',
headers: {'content-type': 'application/json'},
data: {cards: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"cards":[]}'
};
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 = @{ @"cards": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"]
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}}/files/:file_id/metadata/global/boxSkillsCards" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"cards\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards",
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([
'cards' => [
]
]),
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('POST', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards', [
'body' => '{
"cards": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'cards' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'cards' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setRequestMethod('POST');
$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}}/files/:file_id/metadata/global/boxSkillsCards' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"cards": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"cards": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"cards\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/:file_id/metadata/global/boxSkillsCards", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
payload = { "cards": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
payload <- "{\n \"cards\": []\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}}/files/:file_id/metadata/global/boxSkillsCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"cards\": []\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/files/:file_id/metadata/global/boxSkillsCards') do |req|
req.body = "{\n \"cards\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards";
let payload = json!({"cards": ()});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/:file_id/metadata/global/boxSkillsCards \
--header 'content-type: application/json' \
--data '{
"cards": []
}'
echo '{
"cards": []
}' | \
http POST {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "cards": []\n}' \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["cards": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")! 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
{
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "properties",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List Box Skill cards on file
{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/metadata/global/boxSkillsCards HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"))
.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}}/files/:file_id/metadata/global/boxSkillsCards")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.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}}/files/:file_id/metadata/global/boxSkillsCards');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {method: 'GET'};
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}}/files/:file_id/metadata/global/boxSkillsCards',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/global/boxSkillsCards',
headers: {}
};
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}}/files/:file_id/metadata/global/boxSkillsCards'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
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}}/files/:file_id/metadata/global/boxSkillsCards'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/metadata/global/boxSkillsCards" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/metadata/global/boxSkillsCards")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/metadata/global/boxSkillsCards') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
http GET {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "properties",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove Box Skill cards from file
{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/:file_id/metadata/global/boxSkillsCards HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"))
.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}}/files/:file_id/metadata/global/boxSkillsCards")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.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}}/files/:file_id/metadata/global/boxSkillsCards');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {method: 'DELETE'};
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}}/files/:file_id/metadata/global/boxSkillsCards',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/global/boxSkillsCards',
headers: {}
};
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}}/files/:file_id/metadata/global/boxSkillsCards'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
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}}/files/:file_id/metadata/global/boxSkillsCards'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/:file_id/metadata/global/boxSkillsCards" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/:file_id/metadata/global/boxSkillsCards")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/:file_id/metadata/global/boxSkillsCards') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
http DELETE {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update Box Skill cards on file
{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
require "http/client"
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/files/:file_id/metadata/global/boxSkillsCards HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"))
.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}}/files/:file_id/metadata/global/boxSkillsCards")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.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}}/files/:file_id/metadata/global/boxSkillsCards');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {method: 'PUT'};
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}}/files/:file_id/metadata/global/boxSkillsCards',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/metadata/global/boxSkillsCards',
headers: {}
};
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}}/files/:file_id/metadata/global/boxSkillsCards'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
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}}/files/:file_id/metadata/global/boxSkillsCards'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/files/:file_id/metadata/global/boxSkillsCards" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/files/:file_id/metadata/global/boxSkillsCards")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/files/:file_id/metadata/global/boxSkillsCards') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
http PUT {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "properties",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update all Box Skill cards on file
{{baseUrl}}/skill_invocations/:skill_id
QUERY PARAMS
skill_id
BODY json
{
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": {
"cards": []
},
"status": "",
"usage": {
"unit": "",
"value": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/skill_invocations/:skill_id");
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 \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/skill_invocations/:skill_id" {:content-type :json
:form-params {:file {:id ""
:type ""}
:file_version {:id ""
:type ""}
:metadata {:cards []}
:status ""
:usage {:unit ""
:value ""}}})
require "http/client"
url = "{{baseUrl}}/skill_invocations/:skill_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\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}}/skill_invocations/:skill_id"),
Content = new StringContent("{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\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}}/skill_invocations/:skill_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/skill_invocations/:skill_id"
payload := strings.NewReader("{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\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/skill_invocations/:skill_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 205
{
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": {
"cards": []
},
"status": "",
"usage": {
"unit": "",
"value": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/skill_invocations/:skill_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/skill_invocations/:skill_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\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 \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/skill_invocations/:skill_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/skill_invocations/:skill_id")
.header("content-type", "application/json")
.body("{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
file: {
id: '',
type: ''
},
file_version: {
id: '',
type: ''
},
metadata: {
cards: []
},
status: '',
usage: {
unit: '',
value: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/skill_invocations/:skill_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/skill_invocations/:skill_id',
headers: {'content-type': 'application/json'},
data: {
file: {id: '', type: ''},
file_version: {id: '', type: ''},
metadata: {cards: []},
status: '',
usage: {unit: '', value: ''}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/skill_invocations/:skill_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"file":{"id":"","type":""},"file_version":{"id":"","type":""},"metadata":{"cards":[]},"status":"","usage":{"unit":"","value":""}}'
};
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}}/skill_invocations/:skill_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "file": {\n "id": "",\n "type": ""\n },\n "file_version": {\n "id": "",\n "type": ""\n },\n "metadata": {\n "cards": []\n },\n "status": "",\n "usage": {\n "unit": "",\n "value": ""\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 \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/skill_invocations/:skill_id")
.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/skill_invocations/:skill_id',
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({
file: {id: '', type: ''},
file_version: {id: '', type: ''},
metadata: {cards: []},
status: '',
usage: {unit: '', value: ''}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/skill_invocations/:skill_id',
headers: {'content-type': 'application/json'},
body: {
file: {id: '', type: ''},
file_version: {id: '', type: ''},
metadata: {cards: []},
status: '',
usage: {unit: '', value: ''}
},
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}}/skill_invocations/:skill_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
file: {
id: '',
type: ''
},
file_version: {
id: '',
type: ''
},
metadata: {
cards: []
},
status: '',
usage: {
unit: '',
value: ''
}
});
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}}/skill_invocations/:skill_id',
headers: {'content-type': 'application/json'},
data: {
file: {id: '', type: ''},
file_version: {id: '', type: ''},
metadata: {cards: []},
status: '',
usage: {unit: '', value: ''}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/skill_invocations/:skill_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"file":{"id":"","type":""},"file_version":{"id":"","type":""},"metadata":{"cards":[]},"status":"","usage":{"unit":"","value":""}}'
};
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 = @{ @"file": @{ @"id": @"", @"type": @"" },
@"file_version": @{ @"id": @"", @"type": @"" },
@"metadata": @{ @"cards": @[ ] },
@"status": @"",
@"usage": @{ @"unit": @"", @"value": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/skill_invocations/:skill_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}}/skill_invocations/:skill_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/skill_invocations/:skill_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([
'file' => [
'id' => '',
'type' => ''
],
'file_version' => [
'id' => '',
'type' => ''
],
'metadata' => [
'cards' => [
]
],
'status' => '',
'usage' => [
'unit' => '',
'value' => ''
]
]),
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}}/skill_invocations/:skill_id', [
'body' => '{
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": {
"cards": []
},
"status": "",
"usage": {
"unit": "",
"value": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/skill_invocations/:skill_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'file' => [
'id' => '',
'type' => ''
],
'file_version' => [
'id' => '',
'type' => ''
],
'metadata' => [
'cards' => [
]
],
'status' => '',
'usage' => [
'unit' => '',
'value' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'file' => [
'id' => '',
'type' => ''
],
'file_version' => [
'id' => '',
'type' => ''
],
'metadata' => [
'cards' => [
]
],
'status' => '',
'usage' => [
'unit' => '',
'value' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/skill_invocations/:skill_id');
$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}}/skill_invocations/:skill_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": {
"cards": []
},
"status": "",
"usage": {
"unit": "",
"value": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/skill_invocations/:skill_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": {
"cards": []
},
"status": "",
"usage": {
"unit": "",
"value": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/skill_invocations/:skill_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/skill_invocations/:skill_id"
payload = {
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": { "cards": [] },
"status": "",
"usage": {
"unit": "",
"value": ""
}
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/skill_invocations/:skill_id"
payload <- "{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\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}}/skill_invocations/:skill_id")
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 \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\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/skill_invocations/:skill_id') do |req|
req.body = "{\n \"file\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"metadata\": {\n \"cards\": []\n },\n \"status\": \"\",\n \"usage\": {\n \"unit\": \"\",\n \"value\": \"\"\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}}/skill_invocations/:skill_id";
let payload = json!({
"file": json!({
"id": "",
"type": ""
}),
"file_version": json!({
"id": "",
"type": ""
}),
"metadata": json!({"cards": ()}),
"status": "",
"usage": json!({
"unit": "",
"value": ""
})
});
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}}/skill_invocations/:skill_id \
--header 'content-type: application/json' \
--data '{
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": {
"cards": []
},
"status": "",
"usage": {
"unit": "",
"value": ""
}
}'
echo '{
"file": {
"id": "",
"type": ""
},
"file_version": {
"id": "",
"type": ""
},
"metadata": {
"cards": []
},
"status": "",
"usage": {
"unit": "",
"value": ""
}
}' | \
http PUT {{baseUrl}}/skill_invocations/:skill_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "file": {\n "id": "",\n "type": ""\n },\n "file_version": {\n "id": "",\n "type": ""\n },\n "metadata": {\n "cards": []\n },\n "status": "",\n "usage": {\n "unit": "",\n "value": ""\n }\n}' \
--output-document \
- {{baseUrl}}/skill_invocations/:skill_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"file": [
"id": "",
"type": ""
],
"file_version": [
"id": "",
"type": ""
],
"metadata": ["cards": []],
"status": "",
"usage": [
"unit": "",
"value": ""
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/skill_invocations/:skill_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get storage policy
{{baseUrl}}/storage_policies/:storage_policy_id
QUERY PARAMS
storage_policy_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/storage_policies/:storage_policy_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/storage_policies/:storage_policy_id")
require "http/client"
url = "{{baseUrl}}/storage_policies/:storage_policy_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/storage_policies/:storage_policy_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/storage_policies/:storage_policy_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/storage_policies/:storage_policy_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/storage_policies/:storage_policy_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/storage_policies/:storage_policy_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/storage_policies/:storage_policy_id"))
.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}}/storage_policies/:storage_policy_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/storage_policies/:storage_policy_id")
.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}}/storage_policies/:storage_policy_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/storage_policies/:storage_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/storage_policies/:storage_policy_id';
const options = {method: 'GET'};
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}}/storage_policies/:storage_policy_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/storage_policies/:storage_policy_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/storage_policies/:storage_policy_id',
headers: {}
};
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}}/storage_policies/:storage_policy_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/storage_policies/:storage_policy_id');
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}}/storage_policies/:storage_policy_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/storage_policies/:storage_policy_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/storage_policies/:storage_policy_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/storage_policies/:storage_policy_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/storage_policies/:storage_policy_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/storage_policies/:storage_policy_id');
echo $response->getBody();
setUrl('{{baseUrl}}/storage_policies/:storage_policy_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/storage_policies/:storage_policy_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/storage_policies/:storage_policy_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/storage_policies/:storage_policy_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/storage_policies/:storage_policy_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/storage_policies/:storage_policy_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/storage_policies/:storage_policy_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/storage_policies/:storage_policy_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/storage_policies/:storage_policy_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/storage_policies/:storage_policy_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/storage_policies/:storage_policy_id
http GET {{baseUrl}}/storage_policies/:storage_policy_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/storage_policies/:storage_policy_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/storage_policies/:storage_policy_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List storage policies
{{baseUrl}}/storage_policies
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/storage_policies");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/storage_policies")
require "http/client"
url = "{{baseUrl}}/storage_policies"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/storage_policies"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/storage_policies");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/storage_policies"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/storage_policies HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/storage_policies")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/storage_policies"))
.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}}/storage_policies")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/storage_policies")
.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}}/storage_policies');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/storage_policies'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/storage_policies';
const options = {method: 'GET'};
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}}/storage_policies',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/storage_policies")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/storage_policies',
headers: {}
};
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}}/storage_policies'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/storage_policies');
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}}/storage_policies'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/storage_policies';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/storage_policies"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/storage_policies" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/storage_policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/storage_policies');
echo $response->getBody();
setUrl('{{baseUrl}}/storage_policies');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/storage_policies');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/storage_policies' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/storage_policies' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/storage_policies")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/storage_policies"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/storage_policies"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/storage_policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/storage_policies') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/storage_policies";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/storage_policies
http GET {{baseUrl}}/storage_policies
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/storage_policies
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/storage_policies")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Assign storage policy
{{baseUrl}}/storage_policy_assignments
BODY json
{
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/storage_policy_assignments");
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 \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/storage_policy_assignments" {:content-type :json
:form-params {:assigned_to {:id ""
:type ""}
:storage_policy {:id ""
:type ""}}})
require "http/client"
url = "{{baseUrl}}/storage_policy_assignments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/storage_policy_assignments"),
Content = new StringContent("{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/storage_policy_assignments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/storage_policy_assignments"
payload := strings.NewReader("{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/storage_policy_assignments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 111
{
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/storage_policy_assignments")
.setHeader("content-type", "application/json")
.setBody("{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/storage_policy_assignments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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 \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/storage_policy_assignments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/storage_policy_assignments")
.header("content-type", "application/json")
.body("{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
assigned_to: {
id: '',
type: ''
},
storage_policy: {
id: '',
type: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/storage_policy_assignments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/storage_policy_assignments',
headers: {'content-type': 'application/json'},
data: {assigned_to: {id: '', type: ''}, storage_policy: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/storage_policy_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assigned_to":{"id":"","type":""},"storage_policy":{"id":"","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}}/storage_policy_assignments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "assigned_to": {\n "id": "",\n "type": ""\n },\n "storage_policy": {\n "id": "",\n "type": ""\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 \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/storage_policy_assignments")
.post(body)
.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/storage_policy_assignments',
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({assigned_to: {id: '', type: ''}, storage_policy: {id: '', type: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/storage_policy_assignments',
headers: {'content-type': 'application/json'},
body: {assigned_to: {id: '', type: ''}, storage_policy: {id: '', type: ''}},
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}}/storage_policy_assignments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
assigned_to: {
id: '',
type: ''
},
storage_policy: {
id: '',
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: 'POST',
url: '{{baseUrl}}/storage_policy_assignments',
headers: {'content-type': 'application/json'},
data: {assigned_to: {id: '', type: ''}, storage_policy: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/storage_policy_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assigned_to":{"id":"","type":""},"storage_policy":{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"assigned_to": @{ @"id": @"", @"type": @"" },
@"storage_policy": @{ @"id": @"", @"type": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/storage_policy_assignments"]
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}}/storage_policy_assignments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/storage_policy_assignments",
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([
'assigned_to' => [
'id' => '',
'type' => ''
],
'storage_policy' => [
'id' => '',
'type' => ''
]
]),
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('POST', '{{baseUrl}}/storage_policy_assignments', [
'body' => '{
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/storage_policy_assignments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'assigned_to' => [
'id' => '',
'type' => ''
],
'storage_policy' => [
'id' => '',
'type' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'assigned_to' => [
'id' => '',
'type' => ''
],
'storage_policy' => [
'id' => '',
'type' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/storage_policy_assignments');
$request->setRequestMethod('POST');
$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}}/storage_policy_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/storage_policy_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/storage_policy_assignments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/storage_policy_assignments"
payload = {
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/storage_policy_assignments"
payload <- "{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/storage_policy_assignments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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/storage_policy_assignments') do |req|
req.body = "{\n \"assigned_to\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/storage_policy_assignments";
let payload = json!({
"assigned_to": json!({
"id": "",
"type": ""
}),
"storage_policy": json!({
"id": "",
"type": ""
})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/storage_policy_assignments \
--header 'content-type: application/json' \
--data '{
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}'
echo '{
"assigned_to": {
"id": "",
"type": ""
},
"storage_policy": {
"id": "",
"type": ""
}
}' | \
http POST {{baseUrl}}/storage_policy_assignments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "assigned_to": {\n "id": "",\n "type": ""\n },\n "storage_policy": {\n "id": "",\n "type": ""\n }\n}' \
--output-document \
- {{baseUrl}}/storage_policy_assignments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"assigned_to": [
"id": "",
"type": ""
],
"storage_policy": [
"id": "",
"type": ""
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/storage_policy_assignments")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get storage policy assignment
{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
QUERY PARAMS
storage_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
require "http/client"
url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/storage_policy_assignments/:storage_policy_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"))
.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}}/storage_policy_assignments/:storage_policy_assignment_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.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}}/storage_policy_assignments/:storage_policy_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id';
const options = {method: 'GET'};
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}}/storage_policy_assignments/:storage_policy_assignment_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/storage_policy_assignments/:storage_policy_assignment_id',
headers: {}
};
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}}/storage_policy_assignments/:storage_policy_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
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}}/storage_policy_assignments/:storage_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/storage_policy_assignments/:storage_policy_assignment_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/storage_policy_assignments/:storage_policy_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/storage_policy_assignments/:storage_policy_assignment_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
http GET {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List storage policy assignments
{{baseUrl}}/storage_policy_assignments
QUERY PARAMS
resolved_for_type
resolved_for_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/storage_policy_assignments" {:query-params {:resolved_for_type ""
:resolved_for_id ""}})
require "http/client"
url = "{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/storage_policy_assignments?resolved_for_type=&resolved_for_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id="))
.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}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=")
.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}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/storage_policy_assignments',
params: {resolved_for_type: '', resolved_for_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=';
const options = {method: 'GET'};
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}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/storage_policy_assignments?resolved_for_type=&resolved_for_id=',
headers: {}
};
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}}/storage_policy_assignments',
qs: {resolved_for_type: '', resolved_for_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/storage_policy_assignments');
req.query({
resolved_for_type: '',
resolved_for_id: ''
});
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}}/storage_policy_assignments',
params: {resolved_for_type: '', resolved_for_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/storage_policy_assignments');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'resolved_for_type' => '',
'resolved_for_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/storage_policy_assignments');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'resolved_for_type' => '',
'resolved_for_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/storage_policy_assignments?resolved_for_type=&resolved_for_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/storage_policy_assignments"
querystring = {"resolved_for_type":"","resolved_for_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/storage_policy_assignments"
queryString <- list(
resolved_for_type = "",
resolved_for_id = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/storage_policy_assignments') do |req|
req.params['resolved_for_type'] = ''
req.params['resolved_for_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/storage_policy_assignments";
let querystring = [
("resolved_for_type", ""),
("resolved_for_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id='
http GET '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/storage_policy_assignments?resolved_for_type=&resolved_for_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Unassign storage policy
{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
QUERY PARAMS
storage_policy_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
require "http/client"
url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/storage_policy_assignments/:storage_policy_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"))
.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}}/storage_policy_assignments/:storage_policy_assignment_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.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}}/storage_policy_assignments/:storage_policy_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id';
const options = {method: 'DELETE'};
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}}/storage_policy_assignments/:storage_policy_assignment_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/storage_policy_assignments/:storage_policy_assignment_id',
headers: {}
};
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}}/storage_policy_assignments/:storage_policy_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
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}}/storage_policy_assignments/:storage_policy_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/storage_policy_assignments/:storage_policy_assignment_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/storage_policy_assignments/:storage_policy_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/storage_policy_assignments/:storage_policy_assignment_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
http DELETE {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update storage policy assignment
{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
QUERY PARAMS
storage_policy_assignment_id
BODY json
{
"storage_policy": {
"id": "",
"type": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id");
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 \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id" {:content-type :json
:form-params {:storage_policy {:id ""
:type ""}}})
require "http/client"
url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/storage_policy_assignments/:storage_policy_assignment_id"),
Content = new StringContent("{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/storage_policy_assignments/:storage_policy_assignment_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
payload := strings.NewReader("{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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/storage_policy_assignments/:storage_policy_assignment_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 58
{
"storage_policy": {
"id": "",
"type": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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 \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.header("content-type", "application/json")
.body("{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
storage_policy: {
id: '',
type: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id',
headers: {'content-type': 'application/json'},
data: {storage_policy: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"storage_policy":{"id":"","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}}/storage_policy_assignments/:storage_policy_assignment_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "storage_policy": {\n "id": "",\n "type": ""\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 \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id")
.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/storage_policy_assignments/:storage_policy_assignment_id',
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({storage_policy: {id: '', type: ''}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id',
headers: {'content-type': 'application/json'},
body: {storage_policy: {id: '', type: ''}},
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}}/storage_policy_assignments/:storage_policy_assignment_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
storage_policy: {
id: '',
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: 'PUT',
url: '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id',
headers: {'content-type': 'application/json'},
data: {storage_policy: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"storage_policy":{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"storage_policy": @{ @"id": @"", @"type": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_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}}/storage_policy_assignments/:storage_policy_assignment_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_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([
'storage_policy' => [
'id' => '',
'type' => ''
]
]),
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}}/storage_policy_assignments/:storage_policy_assignment_id', [
'body' => '{
"storage_policy": {
"id": "",
"type": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'storage_policy' => [
'id' => '',
'type' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'storage_policy' => [
'id' => '',
'type' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id');
$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}}/storage_policy_assignments/:storage_policy_assignment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"storage_policy": {
"id": "",
"type": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"storage_policy": {
"id": "",
"type": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/storage_policy_assignments/:storage_policy_assignment_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
payload = { "storage_policy": {
"id": "",
"type": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id"
payload <- "{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/storage_policy_assignments/:storage_policy_assignment_id")
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 \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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/storage_policy_assignments/:storage_policy_assignment_id') do |req|
req.body = "{\n \"storage_policy\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/storage_policy_assignments/:storage_policy_assignment_id";
let payload = json!({"storage_policy": json!({
"id": "",
"type": ""
})});
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}}/storage_policy_assignments/:storage_policy_assignment_id \
--header 'content-type: application/json' \
--data '{
"storage_policy": {
"id": "",
"type": ""
}
}'
echo '{
"storage_policy": {
"id": "",
"type": ""
}
}' | \
http PUT {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "storage_policy": {\n "id": "",\n "type": ""\n }\n}' \
--output-document \
- {{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["storage_policy": [
"id": "",
"type": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/storage_policy_assignments/:storage_policy_assignment_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Assign task
{{baseUrl}}/task_assignments
BODY json
{
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/task_assignments");
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 \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/task_assignments" {:content-type :json
:form-params {:assign_to {:id ""
:login ""}
:task {:id ""
:type ""}}})
require "http/client"
url = "{{baseUrl}}/task_assignments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/task_assignments"),
Content = new StringContent("{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/task_assignments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/task_assignments"
payload := strings.NewReader("{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/task_assignments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 100
{
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/task_assignments")
.setHeader("content-type", "application/json")
.setBody("{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/task_assignments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\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 \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/task_assignments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/task_assignments")
.header("content-type", "application/json")
.body("{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
assign_to: {
id: '',
login: ''
},
task: {
id: '',
type: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/task_assignments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/task_assignments',
headers: {'content-type': 'application/json'},
data: {assign_to: {id: '', login: ''}, task: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/task_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assign_to":{"id":"","login":""},"task":{"id":"","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}}/task_assignments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "assign_to": {\n "id": "",\n "login": ""\n },\n "task": {\n "id": "",\n "type": ""\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 \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/task_assignments")
.post(body)
.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/task_assignments',
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({assign_to: {id: '', login: ''}, task: {id: '', type: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/task_assignments',
headers: {'content-type': 'application/json'},
body: {assign_to: {id: '', login: ''}, task: {id: '', type: ''}},
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}}/task_assignments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
assign_to: {
id: '',
login: ''
},
task: {
id: '',
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: 'POST',
url: '{{baseUrl}}/task_assignments',
headers: {'content-type': 'application/json'},
data: {assign_to: {id: '', login: ''}, task: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/task_assignments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"assign_to":{"id":"","login":""},"task":{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"assign_to": @{ @"id": @"", @"login": @"" },
@"task": @{ @"id": @"", @"type": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/task_assignments"]
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}}/task_assignments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/task_assignments",
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([
'assign_to' => [
'id' => '',
'login' => ''
],
'task' => [
'id' => '',
'type' => ''
]
]),
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('POST', '{{baseUrl}}/task_assignments', [
'body' => '{
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/task_assignments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'assign_to' => [
'id' => '',
'login' => ''
],
'task' => [
'id' => '',
'type' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'assign_to' => [
'id' => '',
'login' => ''
],
'task' => [
'id' => '',
'type' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/task_assignments');
$request->setRequestMethod('POST');
$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}}/task_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/task_assignments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/task_assignments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/task_assignments"
payload = {
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/task_assignments"
payload <- "{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/task_assignments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\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/task_assignments') do |req|
req.body = "{\n \"assign_to\": {\n \"id\": \"\",\n \"login\": \"\"\n },\n \"task\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/task_assignments";
let payload = json!({
"assign_to": json!({
"id": "",
"login": ""
}),
"task": json!({
"id": "",
"type": ""
})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/task_assignments \
--header 'content-type: application/json' \
--data '{
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}'
echo '{
"assign_to": {
"id": "",
"login": ""
},
"task": {
"id": "",
"type": ""
}
}' | \
http POST {{baseUrl}}/task_assignments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "assign_to": {\n "id": "",\n "login": ""\n },\n "task": {\n "id": "",\n "type": ""\n }\n}' \
--output-document \
- {{baseUrl}}/task_assignments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"assign_to": [
"id": "",
"login": ""
],
"task": [
"id": "",
"type": ""
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/task_assignments")! 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
{
"assigned_at": "2012-12-12T10:53:43-08:00",
"completed_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"message": "Please review",
"reminded_at": "2012-12-12T10:53:43-08:00",
"resolution_state": "incomplete",
"type": "task_assignment"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get task assignment
{{baseUrl}}/task_assignments/:task_assignment_id
QUERY PARAMS
task_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/task_assignments/:task_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/task_assignments/:task_assignment_id")
require "http/client"
url = "{{baseUrl}}/task_assignments/:task_assignment_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/task_assignments/:task_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/task_assignments/:task_assignment_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/task_assignments/:task_assignment_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/task_assignments/:task_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/task_assignments/:task_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/task_assignments/:task_assignment_id"))
.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}}/task_assignments/:task_assignment_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/task_assignments/:task_assignment_id")
.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}}/task_assignments/:task_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/task_assignments/:task_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/task_assignments/:task_assignment_id';
const options = {method: 'GET'};
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}}/task_assignments/:task_assignment_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/task_assignments/:task_assignment_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/task_assignments/:task_assignment_id',
headers: {}
};
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}}/task_assignments/:task_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/task_assignments/:task_assignment_id');
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}}/task_assignments/:task_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/task_assignments/:task_assignment_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/task_assignments/:task_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/task_assignments/:task_assignment_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/task_assignments/:task_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/task_assignments/:task_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/task_assignments/:task_assignment_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/task_assignments/:task_assignment_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/task_assignments/:task_assignment_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/task_assignments/:task_assignment_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/task_assignments/:task_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/task_assignments/:task_assignment_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/task_assignments/:task_assignment_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/task_assignments/:task_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/task_assignments/:task_assignment_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/task_assignments/:task_assignment_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/task_assignments/:task_assignment_id
http GET {{baseUrl}}/task_assignments/:task_assignment_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/task_assignments/:task_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/task_assignments/:task_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"assigned_at": "2012-12-12T10:53:43-08:00",
"completed_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"message": "Please review",
"reminded_at": "2012-12-12T10:53:43-08:00",
"resolution_state": "incomplete",
"type": "task_assignment"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List task assignments
{{baseUrl}}/tasks/:task_id/assignments
QUERY PARAMS
task_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/tasks/:task_id/assignments");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/tasks/:task_id/assignments")
require "http/client"
url = "{{baseUrl}}/tasks/:task_id/assignments"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/tasks/:task_id/assignments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/tasks/:task_id/assignments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/tasks/:task_id/assignments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/tasks/:task_id/assignments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/tasks/:task_id/assignments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/tasks/:task_id/assignments"))
.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}}/tasks/:task_id/assignments")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/tasks/:task_id/assignments")
.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}}/tasks/:task_id/assignments');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/tasks/:task_id/assignments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/tasks/:task_id/assignments';
const options = {method: 'GET'};
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}}/tasks/:task_id/assignments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/tasks/:task_id/assignments")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/tasks/:task_id/assignments',
headers: {}
};
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}}/tasks/:task_id/assignments'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/tasks/:task_id/assignments');
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}}/tasks/:task_id/assignments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/tasks/:task_id/assignments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/tasks/:task_id/assignments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/tasks/:task_id/assignments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/tasks/:task_id/assignments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/tasks/:task_id/assignments');
echo $response->getBody();
setUrl('{{baseUrl}}/tasks/:task_id/assignments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/tasks/:task_id/assignments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/tasks/:task_id/assignments' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/tasks/:task_id/assignments' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/tasks/:task_id/assignments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/tasks/:task_id/assignments"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/tasks/:task_id/assignments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/tasks/:task_id/assignments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/tasks/:task_id/assignments') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/tasks/:task_id/assignments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/tasks/:task_id/assignments
http GET {{baseUrl}}/tasks/:task_id/assignments
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/tasks/:task_id/assignments
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/tasks/:task_id/assignments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"total_count": 100
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Unassign task
{{baseUrl}}/task_assignments/:task_assignment_id
QUERY PARAMS
task_assignment_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/task_assignments/:task_assignment_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/task_assignments/:task_assignment_id")
require "http/client"
url = "{{baseUrl}}/task_assignments/:task_assignment_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/task_assignments/:task_assignment_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/task_assignments/:task_assignment_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/task_assignments/:task_assignment_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/task_assignments/:task_assignment_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/task_assignments/:task_assignment_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/task_assignments/:task_assignment_id"))
.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}}/task_assignments/:task_assignment_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/task_assignments/:task_assignment_id")
.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}}/task_assignments/:task_assignment_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/task_assignments/:task_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/task_assignments/:task_assignment_id';
const options = {method: 'DELETE'};
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}}/task_assignments/:task_assignment_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/task_assignments/:task_assignment_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/task_assignments/:task_assignment_id',
headers: {}
};
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}}/task_assignments/:task_assignment_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/task_assignments/:task_assignment_id');
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}}/task_assignments/:task_assignment_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/task_assignments/:task_assignment_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/task_assignments/:task_assignment_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/task_assignments/:task_assignment_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/task_assignments/:task_assignment_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/task_assignments/:task_assignment_id');
echo $response->getBody();
setUrl('{{baseUrl}}/task_assignments/:task_assignment_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/task_assignments/:task_assignment_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/task_assignments/:task_assignment_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/task_assignments/:task_assignment_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/task_assignments/:task_assignment_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/task_assignments/:task_assignment_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/task_assignments/:task_assignment_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/task_assignments/:task_assignment_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/task_assignments/:task_assignment_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/task_assignments/:task_assignment_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/task_assignments/:task_assignment_id
http DELETE {{baseUrl}}/task_assignments/:task_assignment_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/task_assignments/:task_assignment_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/task_assignments/:task_assignment_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update task assignment
{{baseUrl}}/task_assignments/:task_assignment_id
QUERY PARAMS
task_assignment_id
BODY json
{
"message": "",
"resolution_state": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/task_assignments/:task_assignment_id");
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 \"message\": \"\",\n \"resolution_state\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/task_assignments/:task_assignment_id" {:content-type :json
:form-params {:message ""
:resolution_state ""}})
require "http/client"
url = "{{baseUrl}}/task_assignments/:task_assignment_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"message\": \"\",\n \"resolution_state\": \"\"\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}}/task_assignments/:task_assignment_id"),
Content = new StringContent("{\n \"message\": \"\",\n \"resolution_state\": \"\"\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}}/task_assignments/:task_assignment_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"message\": \"\",\n \"resolution_state\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/task_assignments/:task_assignment_id"
payload := strings.NewReader("{\n \"message\": \"\",\n \"resolution_state\": \"\"\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/task_assignments/:task_assignment_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 45
{
"message": "",
"resolution_state": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/task_assignments/:task_assignment_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"message\": \"\",\n \"resolution_state\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/task_assignments/:task_assignment_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"message\": \"\",\n \"resolution_state\": \"\"\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 \"message\": \"\",\n \"resolution_state\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/task_assignments/:task_assignment_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/task_assignments/:task_assignment_id")
.header("content-type", "application/json")
.body("{\n \"message\": \"\",\n \"resolution_state\": \"\"\n}")
.asString();
const data = JSON.stringify({
message: '',
resolution_state: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/task_assignments/:task_assignment_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/task_assignments/:task_assignment_id',
headers: {'content-type': 'application/json'},
data: {message: '', resolution_state: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/task_assignments/:task_assignment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"message":"","resolution_state":""}'
};
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}}/task_assignments/:task_assignment_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "message": "",\n "resolution_state": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"message\": \"\",\n \"resolution_state\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/task_assignments/:task_assignment_id")
.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/task_assignments/:task_assignment_id',
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({message: '', resolution_state: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/task_assignments/:task_assignment_id',
headers: {'content-type': 'application/json'},
body: {message: '', resolution_state: ''},
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}}/task_assignments/:task_assignment_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
message: '',
resolution_state: ''
});
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}}/task_assignments/:task_assignment_id',
headers: {'content-type': 'application/json'},
data: {message: '', resolution_state: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/task_assignments/:task_assignment_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"message":"","resolution_state":""}'
};
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 = @{ @"message": @"",
@"resolution_state": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/task_assignments/:task_assignment_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}}/task_assignments/:task_assignment_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"message\": \"\",\n \"resolution_state\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/task_assignments/:task_assignment_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([
'message' => '',
'resolution_state' => ''
]),
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}}/task_assignments/:task_assignment_id', [
'body' => '{
"message": "",
"resolution_state": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/task_assignments/:task_assignment_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'message' => '',
'resolution_state' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'message' => '',
'resolution_state' => ''
]));
$request->setRequestUrl('{{baseUrl}}/task_assignments/:task_assignment_id');
$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}}/task_assignments/:task_assignment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"message": "",
"resolution_state": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/task_assignments/:task_assignment_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"message": "",
"resolution_state": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"message\": \"\",\n \"resolution_state\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/task_assignments/:task_assignment_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/task_assignments/:task_assignment_id"
payload = {
"message": "",
"resolution_state": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/task_assignments/:task_assignment_id"
payload <- "{\n \"message\": \"\",\n \"resolution_state\": \"\"\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}}/task_assignments/:task_assignment_id")
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 \"message\": \"\",\n \"resolution_state\": \"\"\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/task_assignments/:task_assignment_id') do |req|
req.body = "{\n \"message\": \"\",\n \"resolution_state\": \"\"\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}}/task_assignments/:task_assignment_id";
let payload = json!({
"message": "",
"resolution_state": ""
});
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}}/task_assignments/:task_assignment_id \
--header 'content-type: application/json' \
--data '{
"message": "",
"resolution_state": ""
}'
echo '{
"message": "",
"resolution_state": ""
}' | \
http PUT {{baseUrl}}/task_assignments/:task_assignment_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "message": "",\n "resolution_state": ""\n}' \
--output-document \
- {{baseUrl}}/task_assignments/:task_assignment_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"message": "",
"resolution_state": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/task_assignments/:task_assignment_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
{
"assigned_at": "2012-12-12T10:53:43-08:00",
"completed_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"message": "Please review",
"reminded_at": "2012-12-12T10:53:43-08:00",
"resolution_state": "incomplete",
"type": "task_assignment"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create task
{{baseUrl}}/tasks
BODY json
{
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/tasks");
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 \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/tasks" {:content-type :json
:form-params {:action ""
:completion_rule ""
:due_at ""
:item {:id ""
:type ""}
:message ""}})
require "http/client"
url = "{{baseUrl}}/tasks"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\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}}/tasks"),
Content = new StringContent("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\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}}/tasks");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/tasks"
payload := strings.NewReader("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/tasks HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 122
{
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/tasks")
.setHeader("content-type", "application/json")
.setBody("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/tasks"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\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 \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/tasks")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/tasks")
.header("content-type", "application/json")
.body("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}")
.asString();
const data = JSON.stringify({
action: '',
completion_rule: '',
due_at: '',
item: {
id: '',
type: ''
},
message: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/tasks');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/tasks',
headers: {'content-type': 'application/json'},
data: {
action: '',
completion_rule: '',
due_at: '',
item: {id: '', type: ''},
message: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/tasks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"action":"","completion_rule":"","due_at":"","item":{"id":"","type":""},"message":""}'
};
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}}/tasks',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "action": "",\n "completion_rule": "",\n "due_at": "",\n "item": {\n "id": "",\n "type": ""\n },\n "message": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/tasks")
.post(body)
.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/tasks',
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({
action: '',
completion_rule: '',
due_at: '',
item: {id: '', type: ''},
message: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/tasks',
headers: {'content-type': 'application/json'},
body: {
action: '',
completion_rule: '',
due_at: '',
item: {id: '', type: ''},
message: ''
},
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}}/tasks');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
action: '',
completion_rule: '',
due_at: '',
item: {
id: '',
type: ''
},
message: ''
});
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}}/tasks',
headers: {'content-type': 'application/json'},
data: {
action: '',
completion_rule: '',
due_at: '',
item: {id: '', type: ''},
message: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/tasks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"action":"","completion_rule":"","due_at":"","item":{"id":"","type":""},"message":""}'
};
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 = @{ @"action": @"",
@"completion_rule": @"",
@"due_at": @"",
@"item": @{ @"id": @"", @"type": @"" },
@"message": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/tasks"]
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}}/tasks" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/tasks",
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([
'action' => '',
'completion_rule' => '',
'due_at' => '',
'item' => [
'id' => '',
'type' => ''
],
'message' => ''
]),
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('POST', '{{baseUrl}}/tasks', [
'body' => '{
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/tasks');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'action' => '',
'completion_rule' => '',
'due_at' => '',
'item' => [
'id' => '',
'type' => ''
],
'message' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'action' => '',
'completion_rule' => '',
'due_at' => '',
'item' => [
'id' => '',
'type' => ''
],
'message' => ''
]));
$request->setRequestUrl('{{baseUrl}}/tasks');
$request->setRequestMethod('POST');
$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}}/tasks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/tasks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/tasks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/tasks"
payload = {
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/tasks"
payload <- "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\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}}/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\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/tasks') do |req|
req.body = "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"message\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/tasks";
let payload = json!({
"action": "",
"completion_rule": "",
"due_at": "",
"item": json!({
"id": "",
"type": ""
}),
"message": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/tasks \
--header 'content-type: application/json' \
--data '{
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}'
echo '{
"action": "",
"completion_rule": "",
"due_at": "",
"item": {
"id": "",
"type": ""
},
"message": ""
}' | \
http POST {{baseUrl}}/tasks \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "action": "",\n "completion_rule": "",\n "due_at": "",\n "item": {\n "id": "",\n "type": ""\n },\n "message": ""\n}' \
--output-document \
- {{baseUrl}}/tasks
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"action": "",
"completion_rule": "",
"due_at": "",
"item": [
"id": "",
"type": ""
],
"message": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/tasks")! 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
{
"action": "review",
"completion_rule": "all_assignees",
"created_at": "2012-12-12T10:53:43-08:00",
"due_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"is_completed": true,
"message": "Legal review",
"type": "task"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get task
{{baseUrl}}/tasks/:task_id
QUERY PARAMS
task_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/tasks/:task_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/tasks/:task_id")
require "http/client"
url = "{{baseUrl}}/tasks/:task_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/tasks/:task_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/tasks/:task_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/tasks/:task_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/tasks/:task_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/tasks/:task_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/tasks/:task_id"))
.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}}/tasks/:task_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/tasks/:task_id")
.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}}/tasks/:task_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/tasks/:task_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/tasks/:task_id';
const options = {method: 'GET'};
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}}/tasks/:task_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/tasks/:task_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/tasks/:task_id',
headers: {}
};
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}}/tasks/:task_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/tasks/:task_id');
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}}/tasks/:task_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/tasks/:task_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/tasks/:task_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/tasks/:task_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/tasks/:task_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/tasks/:task_id');
echo $response->getBody();
setUrl('{{baseUrl}}/tasks/:task_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/tasks/:task_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/tasks/:task_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/tasks/:task_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/tasks/:task_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/tasks/:task_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/tasks/:task_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/tasks/:task_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/tasks/:task_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/tasks/:task_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/tasks/:task_id
http GET {{baseUrl}}/tasks/:task_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/tasks/:task_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/tasks/:task_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"action": "review",
"completion_rule": "all_assignees",
"created_at": "2012-12-12T10:53:43-08:00",
"due_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"is_completed": true,
"message": "Legal review",
"type": "task"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List tasks on file
{{baseUrl}}/files/:file_id/tasks
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/tasks");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/tasks")
require "http/client"
url = "{{baseUrl}}/files/:file_id/tasks"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/tasks"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/tasks");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/tasks"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/tasks HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/tasks")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/tasks"))
.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}}/files/:file_id/tasks")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/tasks")
.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}}/files/:file_id/tasks');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/files/:file_id/tasks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/tasks';
const options = {method: 'GET'};
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}}/files/:file_id/tasks',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/tasks")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/tasks',
headers: {}
};
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}}/files/:file_id/tasks'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/tasks');
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}}/files/:file_id/tasks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/tasks';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/tasks"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/tasks" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/tasks');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/tasks');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/tasks');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/tasks' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/tasks' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/tasks")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/tasks"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/tasks"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/tasks') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/tasks";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/tasks
http GET {{baseUrl}}/files/:file_id/tasks
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/tasks
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/tasks")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"total_count": 5000
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove task
{{baseUrl}}/tasks/:task_id
QUERY PARAMS
task_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/tasks/:task_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/tasks/:task_id")
require "http/client"
url = "{{baseUrl}}/tasks/:task_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/tasks/:task_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/tasks/:task_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/tasks/:task_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/tasks/:task_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/tasks/:task_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/tasks/:task_id"))
.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}}/tasks/:task_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/tasks/:task_id")
.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}}/tasks/:task_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/tasks/:task_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/tasks/:task_id';
const options = {method: 'DELETE'};
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}}/tasks/:task_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/tasks/:task_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/tasks/:task_id',
headers: {}
};
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}}/tasks/:task_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/tasks/:task_id');
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}}/tasks/:task_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/tasks/:task_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/tasks/:task_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/tasks/:task_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/tasks/:task_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/tasks/:task_id');
echo $response->getBody();
setUrl('{{baseUrl}}/tasks/:task_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/tasks/:task_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/tasks/:task_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/tasks/:task_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/tasks/:task_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/tasks/:task_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/tasks/:task_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/tasks/:task_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/tasks/:task_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/tasks/:task_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/tasks/:task_id
http DELETE {{baseUrl}}/tasks/:task_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/tasks/:task_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/tasks/:task_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update task
{{baseUrl}}/tasks/:task_id
QUERY PARAMS
task_id
BODY json
{
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/tasks/:task_id");
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 \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/tasks/:task_id" {:content-type :json
:form-params {:action ""
:completion_rule ""
:due_at ""
:message ""}})
require "http/client"
url = "{{baseUrl}}/tasks/:task_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\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}}/tasks/:task_id"),
Content = new StringContent("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\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}}/tasks/:task_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/tasks/:task_id"
payload := strings.NewReader("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\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/tasks/:task_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 76
{
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/tasks/:task_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/tasks/:task_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\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 \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/tasks/:task_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/tasks/:task_id")
.header("content-type", "application/json")
.body("{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}")
.asString();
const data = JSON.stringify({
action: '',
completion_rule: '',
due_at: '',
message: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/tasks/:task_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/tasks/:task_id',
headers: {'content-type': 'application/json'},
data: {action: '', completion_rule: '', due_at: '', message: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/tasks/:task_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"action":"","completion_rule":"","due_at":"","message":""}'
};
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}}/tasks/:task_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "action": "",\n "completion_rule": "",\n "due_at": "",\n "message": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/tasks/:task_id")
.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/tasks/:task_id',
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({action: '', completion_rule: '', due_at: '', message: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/tasks/:task_id',
headers: {'content-type': 'application/json'},
body: {action: '', completion_rule: '', due_at: '', message: ''},
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}}/tasks/:task_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
action: '',
completion_rule: '',
due_at: '',
message: ''
});
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}}/tasks/:task_id',
headers: {'content-type': 'application/json'},
data: {action: '', completion_rule: '', due_at: '', message: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/tasks/:task_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"action":"","completion_rule":"","due_at":"","message":""}'
};
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 = @{ @"action": @"",
@"completion_rule": @"",
@"due_at": @"",
@"message": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/tasks/:task_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}}/tasks/:task_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/tasks/:task_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([
'action' => '',
'completion_rule' => '',
'due_at' => '',
'message' => ''
]),
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}}/tasks/:task_id', [
'body' => '{
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/tasks/:task_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'action' => '',
'completion_rule' => '',
'due_at' => '',
'message' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'action' => '',
'completion_rule' => '',
'due_at' => '',
'message' => ''
]));
$request->setRequestUrl('{{baseUrl}}/tasks/:task_id');
$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}}/tasks/:task_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/tasks/:task_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/tasks/:task_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/tasks/:task_id"
payload = {
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/tasks/:task_id"
payload <- "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\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}}/tasks/:task_id")
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 \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\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/tasks/:task_id') do |req|
req.body = "{\n \"action\": \"\",\n \"completion_rule\": \"\",\n \"due_at\": \"\",\n \"message\": \"\"\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}}/tasks/:task_id";
let payload = json!({
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
});
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}}/tasks/:task_id \
--header 'content-type: application/json' \
--data '{
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}'
echo '{
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
}' | \
http PUT {{baseUrl}}/tasks/:task_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "action": "",\n "completion_rule": "",\n "due_at": "",\n "message": ""\n}' \
--output-document \
- {{baseUrl}}/tasks/:task_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"action": "",
"completion_rule": "",
"due_at": "",
"message": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/tasks/:task_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
{
"action": "review",
"completion_rule": "all_assignees",
"created_at": "2012-12-12T10:53:43-08:00",
"due_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"is_completed": true,
"message": "Legal review",
"type": "task"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create terms of service
{{baseUrl}}/terms_of_services
BODY json
{
"status": "",
"text": "",
"tos_type": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/terms_of_services");
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 \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/terms_of_services" {:content-type :json
:form-params {:status ""
:text ""
:tos_type ""}})
require "http/client"
url = "{{baseUrl}}/terms_of_services"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\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}}/terms_of_services"),
Content = new StringContent("{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\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}}/terms_of_services");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/terms_of_services"
payload := strings.NewReader("{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/terms_of_services HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 50
{
"status": "",
"text": "",
"tos_type": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/terms_of_services")
.setHeader("content-type", "application/json")
.setBody("{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/terms_of_services"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\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 \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/terms_of_services")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/terms_of_services")
.header("content-type", "application/json")
.body("{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}")
.asString();
const data = JSON.stringify({
status: '',
text: '',
tos_type: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/terms_of_services');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/terms_of_services',
headers: {'content-type': 'application/json'},
data: {status: '', text: '', tos_type: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/terms_of_services';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"status":"","text":"","tos_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}}/terms_of_services',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "status": "",\n "text": "",\n "tos_type": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/terms_of_services")
.post(body)
.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/terms_of_services',
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({status: '', text: '', tos_type: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/terms_of_services',
headers: {'content-type': 'application/json'},
body: {status: '', text: '', tos_type: ''},
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}}/terms_of_services');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
status: '',
text: '',
tos_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: 'POST',
url: '{{baseUrl}}/terms_of_services',
headers: {'content-type': 'application/json'},
data: {status: '', text: '', tos_type: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/terms_of_services';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"status":"","text":"","tos_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": @"application/json" };
NSDictionary *parameters = @{ @"status": @"",
@"text": @"",
@"tos_type": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/terms_of_services"]
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}}/terms_of_services" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/terms_of_services",
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([
'status' => '',
'text' => '',
'tos_type' => ''
]),
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('POST', '{{baseUrl}}/terms_of_services', [
'body' => '{
"status": "",
"text": "",
"tos_type": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/terms_of_services');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'status' => '',
'text' => '',
'tos_type' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'status' => '',
'text' => '',
'tos_type' => ''
]));
$request->setRequestUrl('{{baseUrl}}/terms_of_services');
$request->setRequestMethod('POST');
$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}}/terms_of_services' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"status": "",
"text": "",
"tos_type": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/terms_of_services' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"status": "",
"text": "",
"tos_type": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/terms_of_services", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/terms_of_services"
payload = {
"status": "",
"text": "",
"tos_type": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/terms_of_services"
payload <- "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\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}}/terms_of_services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\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/terms_of_services') do |req|
req.body = "{\n \"status\": \"\",\n \"text\": \"\",\n \"tos_type\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/terms_of_services";
let payload = json!({
"status": "",
"text": "",
"tos_type": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/terms_of_services \
--header 'content-type: application/json' \
--data '{
"status": "",
"text": "",
"tos_type": ""
}'
echo '{
"status": "",
"text": "",
"tos_type": ""
}' | \
http POST {{baseUrl}}/terms_of_services \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "status": "",\n "text": "",\n "tos_type": ""\n}' \
--output-document \
- {{baseUrl}}/terms_of_services
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"status": "",
"text": "",
"tos_type": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/terms_of_services")! 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
{
"action": "review",
"completion_rule": "all_assignees",
"created_at": "2012-12-12T10:53:43-08:00",
"due_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"is_completed": true,
"message": "Legal review",
"type": "task"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get terms of service
{{baseUrl}}/terms_of_services/:terms_of_service_id
QUERY PARAMS
terms_of_service_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/terms_of_services/:terms_of_service_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/terms_of_services/:terms_of_service_id")
require "http/client"
url = "{{baseUrl}}/terms_of_services/:terms_of_service_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/terms_of_services/:terms_of_service_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/terms_of_services/:terms_of_service_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/terms_of_services/:terms_of_service_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/terms_of_services/:terms_of_service_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/terms_of_services/:terms_of_service_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/terms_of_services/:terms_of_service_id"))
.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}}/terms_of_services/:terms_of_service_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/terms_of_services/:terms_of_service_id")
.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}}/terms_of_services/:terms_of_service_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/terms_of_services/:terms_of_service_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/terms_of_services/:terms_of_service_id';
const options = {method: 'GET'};
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}}/terms_of_services/:terms_of_service_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/terms_of_services/:terms_of_service_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/terms_of_services/:terms_of_service_id',
headers: {}
};
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}}/terms_of_services/:terms_of_service_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/terms_of_services/:terms_of_service_id');
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}}/terms_of_services/:terms_of_service_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/terms_of_services/:terms_of_service_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/terms_of_services/:terms_of_service_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/terms_of_services/:terms_of_service_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/terms_of_services/:terms_of_service_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/terms_of_services/:terms_of_service_id');
echo $response->getBody();
setUrl('{{baseUrl}}/terms_of_services/:terms_of_service_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/terms_of_services/:terms_of_service_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/terms_of_services/:terms_of_service_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/terms_of_services/:terms_of_service_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/terms_of_services/:terms_of_service_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/terms_of_services/:terms_of_service_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/terms_of_services/:terms_of_service_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/terms_of_services/:terms_of_service_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/terms_of_services/:terms_of_service_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/terms_of_services/:terms_of_service_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/terms_of_services/:terms_of_service_id
http GET {{baseUrl}}/terms_of_services/:terms_of_service_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/terms_of_services/:terms_of_service_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/terms_of_services/:terms_of_service_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List terms of services
{{baseUrl}}/terms_of_services
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/terms_of_services");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/terms_of_services")
require "http/client"
url = "{{baseUrl}}/terms_of_services"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/terms_of_services"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/terms_of_services");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/terms_of_services"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/terms_of_services HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/terms_of_services")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/terms_of_services"))
.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}}/terms_of_services")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/terms_of_services")
.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}}/terms_of_services');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/terms_of_services'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/terms_of_services';
const options = {method: 'GET'};
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}}/terms_of_services',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/terms_of_services")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/terms_of_services',
headers: {}
};
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}}/terms_of_services'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/terms_of_services');
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}}/terms_of_services'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/terms_of_services';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/terms_of_services"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/terms_of_services" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/terms_of_services",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/terms_of_services');
echo $response->getBody();
setUrl('{{baseUrl}}/terms_of_services');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/terms_of_services');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/terms_of_services' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/terms_of_services' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/terms_of_services")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/terms_of_services"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/terms_of_services"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/terms_of_services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/terms_of_services') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/terms_of_services";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/terms_of_services
http GET {{baseUrl}}/terms_of_services
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/terms_of_services
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/terms_of_services")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"total_count": 2
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update terms of service
{{baseUrl}}/terms_of_services/:terms_of_service_id
QUERY PARAMS
terms_of_service_id
BODY json
{
"status": "",
"text": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/terms_of_services/:terms_of_service_id");
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 \"status\": \"\",\n \"text\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/terms_of_services/:terms_of_service_id" {:content-type :json
:form-params {:status ""
:text ""}})
require "http/client"
url = "{{baseUrl}}/terms_of_services/:terms_of_service_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"status\": \"\",\n \"text\": \"\"\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}}/terms_of_services/:terms_of_service_id"),
Content = new StringContent("{\n \"status\": \"\",\n \"text\": \"\"\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}}/terms_of_services/:terms_of_service_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"status\": \"\",\n \"text\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/terms_of_services/:terms_of_service_id"
payload := strings.NewReader("{\n \"status\": \"\",\n \"text\": \"\"\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/terms_of_services/:terms_of_service_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 32
{
"status": "",
"text": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/terms_of_services/:terms_of_service_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"status\": \"\",\n \"text\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/terms_of_services/:terms_of_service_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"status\": \"\",\n \"text\": \"\"\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 \"status\": \"\",\n \"text\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/terms_of_services/:terms_of_service_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/terms_of_services/:terms_of_service_id")
.header("content-type", "application/json")
.body("{\n \"status\": \"\",\n \"text\": \"\"\n}")
.asString();
const data = JSON.stringify({
status: '',
text: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/terms_of_services/:terms_of_service_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/terms_of_services/:terms_of_service_id',
headers: {'content-type': 'application/json'},
data: {status: '', text: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/terms_of_services/:terms_of_service_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"status":"","text":""}'
};
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}}/terms_of_services/:terms_of_service_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "status": "",\n "text": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"status\": \"\",\n \"text\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/terms_of_services/:terms_of_service_id")
.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/terms_of_services/:terms_of_service_id',
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({status: '', text: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/terms_of_services/:terms_of_service_id',
headers: {'content-type': 'application/json'},
body: {status: '', text: ''},
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}}/terms_of_services/:terms_of_service_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
status: '',
text: ''
});
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}}/terms_of_services/:terms_of_service_id',
headers: {'content-type': 'application/json'},
data: {status: '', text: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/terms_of_services/:terms_of_service_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"status":"","text":""}'
};
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 = @{ @"status": @"",
@"text": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/terms_of_services/:terms_of_service_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}}/terms_of_services/:terms_of_service_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"status\": \"\",\n \"text\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/terms_of_services/:terms_of_service_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([
'status' => '',
'text' => ''
]),
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}}/terms_of_services/:terms_of_service_id', [
'body' => '{
"status": "",
"text": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/terms_of_services/:terms_of_service_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'status' => '',
'text' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'status' => '',
'text' => ''
]));
$request->setRequestUrl('{{baseUrl}}/terms_of_services/:terms_of_service_id');
$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}}/terms_of_services/:terms_of_service_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"status": "",
"text": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/terms_of_services/:terms_of_service_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"status": "",
"text": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"status\": \"\",\n \"text\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/terms_of_services/:terms_of_service_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/terms_of_services/:terms_of_service_id"
payload = {
"status": "",
"text": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/terms_of_services/:terms_of_service_id"
payload <- "{\n \"status\": \"\",\n \"text\": \"\"\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}}/terms_of_services/:terms_of_service_id")
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 \"status\": \"\",\n \"text\": \"\"\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/terms_of_services/:terms_of_service_id') do |req|
req.body = "{\n \"status\": \"\",\n \"text\": \"\"\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}}/terms_of_services/:terms_of_service_id";
let payload = json!({
"status": "",
"text": ""
});
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}}/terms_of_services/:terms_of_service_id \
--header 'content-type: application/json' \
--data '{
"status": "",
"text": ""
}'
echo '{
"status": "",
"text": ""
}' | \
http PUT {{baseUrl}}/terms_of_services/:terms_of_service_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "status": "",\n "text": ""\n}' \
--output-document \
- {{baseUrl}}/terms_of_services/:terms_of_service_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"status": "",
"text": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/terms_of_services/:terms_of_service_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create terms of service status for new user
{{baseUrl}}/terms_of_service_user_statuses
BODY json
{
"is_accepted": false,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/terms_of_service_user_statuses");
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 \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/terms_of_service_user_statuses" {:content-type :json
:form-params {:is_accepted false
:tos {:id ""
:type ""}
:user {:id ""
:type ""}}})
require "http/client"
url = "{{baseUrl}}/terms_of_service_user_statuses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/terms_of_service_user_statuses"),
Content = new StringContent("{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/terms_of_service_user_statuses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/terms_of_service_user_statuses"
payload := strings.NewReader("{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/terms_of_service_user_statuses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 117
{
"is_accepted": false,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/terms_of_service_user_statuses")
.setHeader("content-type", "application/json")
.setBody("{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/terms_of_service_user_statuses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\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 \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/terms_of_service_user_statuses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/terms_of_service_user_statuses")
.header("content-type", "application/json")
.body("{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
is_accepted: false,
tos: {
id: '',
type: ''
},
user: {
id: '',
type: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/terms_of_service_user_statuses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/terms_of_service_user_statuses',
headers: {'content-type': 'application/json'},
data: {is_accepted: false, tos: {id: '', type: ''}, user: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/terms_of_service_user_statuses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"is_accepted":false,"tos":{"id":"","type":""},"user":{"id":"","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}}/terms_of_service_user_statuses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "is_accepted": false,\n "tos": {\n "id": "",\n "type": ""\n },\n "user": {\n "id": "",\n "type": ""\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 \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/terms_of_service_user_statuses")
.post(body)
.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/terms_of_service_user_statuses',
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({is_accepted: false, tos: {id: '', type: ''}, user: {id: '', type: ''}}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/terms_of_service_user_statuses',
headers: {'content-type': 'application/json'},
body: {is_accepted: false, tos: {id: '', type: ''}, user: {id: '', type: ''}},
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}}/terms_of_service_user_statuses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
is_accepted: false,
tos: {
id: '',
type: ''
},
user: {
id: '',
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: 'POST',
url: '{{baseUrl}}/terms_of_service_user_statuses',
headers: {'content-type': 'application/json'},
data: {is_accepted: false, tos: {id: '', type: ''}, user: {id: '', type: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/terms_of_service_user_statuses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"is_accepted":false,"tos":{"id":"","type":""},"user":{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"is_accepted": @NO,
@"tos": @{ @"id": @"", @"type": @"" },
@"user": @{ @"id": @"", @"type": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/terms_of_service_user_statuses"]
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}}/terms_of_service_user_statuses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/terms_of_service_user_statuses",
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([
'is_accepted' => null,
'tos' => [
'id' => '',
'type' => ''
],
'user' => [
'id' => '',
'type' => ''
]
]),
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('POST', '{{baseUrl}}/terms_of_service_user_statuses', [
'body' => '{
"is_accepted": false,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/terms_of_service_user_statuses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'is_accepted' => null,
'tos' => [
'id' => '',
'type' => ''
],
'user' => [
'id' => '',
'type' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'is_accepted' => null,
'tos' => [
'id' => '',
'type' => ''
],
'user' => [
'id' => '',
'type' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/terms_of_service_user_statuses');
$request->setRequestMethod('POST');
$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}}/terms_of_service_user_statuses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"is_accepted": false,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/terms_of_service_user_statuses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"is_accepted": false,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/terms_of_service_user_statuses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/terms_of_service_user_statuses"
payload = {
"is_accepted": False,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/terms_of_service_user_statuses"
payload <- "{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\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}}/terms_of_service_user_statuses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\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/terms_of_service_user_statuses') do |req|
req.body = "{\n \"is_accepted\": false,\n \"tos\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"user\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/terms_of_service_user_statuses";
let payload = json!({
"is_accepted": false,
"tos": json!({
"id": "",
"type": ""
}),
"user": json!({
"id": "",
"type": ""
})
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/terms_of_service_user_statuses \
--header 'content-type: application/json' \
--data '{
"is_accepted": false,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}'
echo '{
"is_accepted": false,
"tos": {
"id": "",
"type": ""
},
"user": {
"id": "",
"type": ""
}
}' | \
http POST {{baseUrl}}/terms_of_service_user_statuses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "is_accepted": false,\n "tos": {\n "id": "",\n "type": ""\n },\n "user": {\n "id": "",\n "type": ""\n }\n}' \
--output-document \
- {{baseUrl}}/terms_of_service_user_statuses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"is_accepted": false,
"tos": [
"id": "",
"type": ""
],
"user": [
"id": "",
"type": ""
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/terms_of_service_user_statuses")! 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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"is_accepted": true,
"modified_at": "2012-12-12T10:53:43-08:00",
"type": "terms_of_service_user_status"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List terms of service user statuses
{{baseUrl}}/terms_of_service_user_statuses
QUERY PARAMS
tos_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/terms_of_service_user_statuses?tos_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/terms_of_service_user_statuses" {:query-params {:tos_id ""}})
require "http/client"
url = "{{baseUrl}}/terms_of_service_user_statuses?tos_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/terms_of_service_user_statuses?tos_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/terms_of_service_user_statuses?tos_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/terms_of_service_user_statuses?tos_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/terms_of_service_user_statuses?tos_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/terms_of_service_user_statuses?tos_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/terms_of_service_user_statuses?tos_id="))
.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}}/terms_of_service_user_statuses?tos_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/terms_of_service_user_statuses?tos_id=")
.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}}/terms_of_service_user_statuses?tos_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/terms_of_service_user_statuses',
params: {tos_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/terms_of_service_user_statuses?tos_id=';
const options = {method: 'GET'};
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}}/terms_of_service_user_statuses?tos_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/terms_of_service_user_statuses?tos_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/terms_of_service_user_statuses?tos_id=',
headers: {}
};
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}}/terms_of_service_user_statuses',
qs: {tos_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/terms_of_service_user_statuses');
req.query({
tos_id: ''
});
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}}/terms_of_service_user_statuses',
params: {tos_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/terms_of_service_user_statuses?tos_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/terms_of_service_user_statuses?tos_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/terms_of_service_user_statuses?tos_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/terms_of_service_user_statuses?tos_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/terms_of_service_user_statuses?tos_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/terms_of_service_user_statuses');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'tos_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/terms_of_service_user_statuses');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'tos_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/terms_of_service_user_statuses?tos_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/terms_of_service_user_statuses?tos_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/terms_of_service_user_statuses?tos_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/terms_of_service_user_statuses"
querystring = {"tos_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/terms_of_service_user_statuses"
queryString <- list(tos_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/terms_of_service_user_statuses?tos_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/terms_of_service_user_statuses') do |req|
req.params['tos_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/terms_of_service_user_statuses";
let querystring = [
("tos_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/terms_of_service_user_statuses?tos_id='
http GET '{{baseUrl}}/terms_of_service_user_statuses?tos_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/terms_of_service_user_statuses?tos_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/terms_of_service_user_statuses?tos_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"total_count": 2
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update terms of service status for existing user
{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id
QUERY PARAMS
terms_of_service_user_status_id
BODY json
{
"is_accepted": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id");
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 \"is_accepted\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id" {:content-type :json
:form-params {:is_accepted false}})
require "http/client"
url = "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"is_accepted\": false\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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id"),
Content = new StringContent("{\n \"is_accepted\": false\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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"is_accepted\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id"
payload := strings.NewReader("{\n \"is_accepted\": false\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/terms_of_service_user_statuses/:terms_of_service_user_status_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 26
{
"is_accepted": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"is_accepted\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"is_accepted\": false\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 \"is_accepted\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id")
.header("content-type", "application/json")
.body("{\n \"is_accepted\": false\n}")
.asString();
const data = JSON.stringify({
is_accepted: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id',
headers: {'content-type': 'application/json'},
data: {is_accepted: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"is_accepted":false}'
};
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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "is_accepted": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"is_accepted\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id")
.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/terms_of_service_user_statuses/:terms_of_service_user_status_id',
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({is_accepted: false}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id',
headers: {'content-type': 'application/json'},
body: {is_accepted: false},
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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
is_accepted: false
});
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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id',
headers: {'content-type': 'application/json'},
data: {is_accepted: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"is_accepted":false}'
};
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 = @{ @"is_accepted": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"is_accepted\": false\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_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([
'is_accepted' => null
]),
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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id', [
'body' => '{
"is_accepted": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'is_accepted' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'is_accepted' => null
]));
$request->setRequestUrl('{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id');
$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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"is_accepted": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"is_accepted": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"is_accepted\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/terms_of_service_user_statuses/:terms_of_service_user_status_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id"
payload = { "is_accepted": False }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id"
payload <- "{\n \"is_accepted\": false\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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id")
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 \"is_accepted\": false\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/terms_of_service_user_statuses/:terms_of_service_user_status_id') do |req|
req.body = "{\n \"is_accepted\": false\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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id";
let payload = json!({"is_accepted": false});
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}}/terms_of_service_user_statuses/:terms_of_service_user_status_id \
--header 'content-type: application/json' \
--data '{
"is_accepted": false
}'
echo '{
"is_accepted": false
}' | \
http PUT {{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "is_accepted": false\n}' \
--output-document \
- {{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["is_accepted": false] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/terms_of_service_user_statuses/:terms_of_service_user_status_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
{
"created_at": "2012-12-12T10:53:43-08:00",
"id": "11446498",
"is_accepted": true,
"modified_at": "2012-12-12T10:53:43-08:00",
"type": "terms_of_service_user_status"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Transfer owned folders
{{baseUrl}}/users/:user_id/folders/0
QUERY PARAMS
user_id
BODY json
{
"owned_by": {
"id": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/folders/0");
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 \"owned_by\": {\n \"id\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/users/:user_id/folders/0" {:content-type :json
:form-params {:owned_by {:id ""}}})
require "http/client"
url = "{{baseUrl}}/users/:user_id/folders/0"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"owned_by\": {\n \"id\": \"\"\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}}/users/:user_id/folders/0"),
Content = new StringContent("{\n \"owned_by\": {\n \"id\": \"\"\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}}/users/:user_id/folders/0");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"owned_by\": {\n \"id\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/folders/0"
payload := strings.NewReader("{\n \"owned_by\": {\n \"id\": \"\"\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/users/:user_id/folders/0 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 36
{
"owned_by": {
"id": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/users/:user_id/folders/0")
.setHeader("content-type", "application/json")
.setBody("{\n \"owned_by\": {\n \"id\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/folders/0"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"owned_by\": {\n \"id\": \"\"\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 \"owned_by\": {\n \"id\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:user_id/folders/0")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/users/:user_id/folders/0")
.header("content-type", "application/json")
.body("{\n \"owned_by\": {\n \"id\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
owned_by: {
id: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/users/:user_id/folders/0');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/users/:user_id/folders/0',
headers: {'content-type': 'application/json'},
data: {owned_by: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/folders/0';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"owned_by":{"id":""}}'
};
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}}/users/:user_id/folders/0',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "owned_by": {\n "id": ""\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 \"owned_by\": {\n \"id\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/folders/0")
.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/users/:user_id/folders/0',
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({owned_by: {id: ''}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/users/:user_id/folders/0',
headers: {'content-type': 'application/json'},
body: {owned_by: {id: ''}},
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}}/users/:user_id/folders/0');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
owned_by: {
id: ''
}
});
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}}/users/:user_id/folders/0',
headers: {'content-type': 'application/json'},
data: {owned_by: {id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id/folders/0';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"owned_by":{"id":""}}'
};
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 = @{ @"owned_by": @{ @"id": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/folders/0"]
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}}/users/:user_id/folders/0" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"owned_by\": {\n \"id\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/folders/0",
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([
'owned_by' => [
'id' => ''
]
]),
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}}/users/:user_id/folders/0', [
'body' => '{
"owned_by": {
"id": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/folders/0');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'owned_by' => [
'id' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'owned_by' => [
'id' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/users/:user_id/folders/0');
$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}}/users/:user_id/folders/0' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"owned_by": {
"id": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/folders/0' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"owned_by": {
"id": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"owned_by\": {\n \"id\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/users/:user_id/folders/0", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/folders/0"
payload = { "owned_by": { "id": "" } }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/folders/0"
payload <- "{\n \"owned_by\": {\n \"id\": \"\"\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}}/users/:user_id/folders/0")
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 \"owned_by\": {\n \"id\": \"\"\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/users/:user_id/folders/0') do |req|
req.body = "{\n \"owned_by\": {\n \"id\": \"\"\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}}/users/:user_id/folders/0";
let payload = json!({"owned_by": json!({"id": ""})});
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}}/users/:user_id/folders/0 \
--header 'content-type: application/json' \
--data '{
"owned_by": {
"id": ""
}
}'
echo '{
"owned_by": {
"id": ""
}
}' | \
http PUT {{baseUrl}}/users/:user_id/folders/0 \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "owned_by": {\n "id": ""\n }\n}' \
--output-document \
- {{baseUrl}}/users/:user_id/folders/0
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["owned_by": ["id": ""]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/folders/0")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get trashed file
{{baseUrl}}/files/:file_id/trash
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/trash");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/trash")
require "http/client"
url = "{{baseUrl}}/files/:file_id/trash"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/trash"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/trash");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/trash"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/trash HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/trash")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/trash"))
.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}}/files/:file_id/trash")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/trash")
.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}}/files/:file_id/trash');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/files/:file_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/trash';
const options = {method: 'GET'};
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}}/files/:file_id/trash',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/trash")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/trash',
headers: {}
};
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}}/files/:file_id/trash'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/trash');
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}}/files/:file_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/trash';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/trash"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/trash" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/trash",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/trash');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/trash');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/trash');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/trash' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/trash' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/trash")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/trash"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/trash"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/trash")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/trash') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/trash";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/trash
http GET {{baseUrl}}/files/:file_id/trash
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/trash
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/trash")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"description": "Contract for Q1 renewal",
"etag": "1",
"id": "123456789",
"item_status": "trashed",
"modified_at": "2012-12-12T10:53:43-08:00",
"name": "Contract.pdf",
"purged_at": "2012-12-12T10:53:43-08:00",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"shared_link": null,
"size": 629644,
"trashed_at": "2012-12-12T10:53:43-08:00",
"type": "file"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Permanently remove file
{{baseUrl}}/files/:file_id/trash
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/trash");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/:file_id/trash")
require "http/client"
url = "{{baseUrl}}/files/:file_id/trash"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/trash"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/trash");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/trash"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/:file_id/trash HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/:file_id/trash")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/trash"))
.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}}/files/:file_id/trash")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/:file_id/trash")
.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}}/files/:file_id/trash');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/files/:file_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/trash';
const options = {method: 'DELETE'};
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}}/files/:file_id/trash',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/trash")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/trash',
headers: {}
};
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}}/files/:file_id/trash'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/:file_id/trash');
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}}/files/:file_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/trash';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/trash"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/:file_id/trash" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/trash",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/:file_id/trash');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/trash');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/trash');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/trash' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/trash' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/:file_id/trash")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/trash"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/trash"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/trash")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/:file_id/trash') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/trash";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/:file_id/trash
http DELETE {{baseUrl}}/files/:file_id/trash
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/:file_id/trash
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/trash")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Restore file
{{baseUrl}}/files/:file_id
QUERY PARAMS
file_id
BODY json
{
"name": "",
"parent": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id");
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 \"name\": \"\",\n \"parent\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id" {:content-type :json
:form-params {:name ""
:parent ""}})
require "http/client"
url = "{{baseUrl}}/files/:file_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"parent\": \"\"\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}}/files/:file_id"),
Content = new StringContent("{\n \"name\": \"\",\n \"parent\": \"\"\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}}/files/:file_id");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"parent\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id"
payload := strings.NewReader("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 32
{
"name": "",
"parent": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"parent\": \"\"\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 \"name\": \"\",\n \"parent\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
.asString();
const data = JSON.stringify({
name: '',
parent: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/:file_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id',
headers: {'content-type': 'application/json'},
data: {name: '', parent: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":""}'
};
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}}/files/:file_id',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "parent": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"parent\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id")
.post(body)
.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/files/:file_id',
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({name: '', parent: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id',
headers: {'content-type': 'application/json'},
body: {name: '', parent: ''},
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}}/files/:file_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
parent: ''
});
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}}/files/:file_id',
headers: {'content-type': 'application/json'},
data: {name: '', parent: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":""}'
};
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 = @{ @"name": @"",
@"parent": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id"]
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}}/files/:file_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"parent\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id",
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' => '',
'parent' => ''
]),
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('POST', '{{baseUrl}}/files/:file_id', [
'body' => '{
"name": "",
"parent": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'parent' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'name' => '',
'parent' => ''
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id');
$request->setRequestMethod('POST');
$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}}/files/:file_id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"parent\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/:file_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id"
payload = {
"name": "",
"parent": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id"
payload <- "{\n \"name\": \"\",\n \"parent\": \"\"\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}}/files/:file_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"parent\": \"\"\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/files/:file_id') do |req|
req.body = "{\n \"name\": \"\",\n \"parent\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id";
let payload = json!({
"name": "",
"parent": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/:file_id \
--header 'content-type: application/json' \
--data '{
"name": "",
"parent": ""
}'
echo '{
"name": "",
"parent": ""
}' | \
http POST {{baseUrl}}/files/:file_id \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "parent": ""\n}' \
--output-document \
- {{baseUrl}}/files/:file_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"parent": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id")! 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
{
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"description": "Contract for Q1 renewal",
"etag": "1",
"id": "123456789",
"item_status": "active",
"modified_at": "2012-12-12T10:53:43-08:00",
"name": "Contract.pdf",
"purged_at": null,
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"shared_link": null,
"size": 629644,
"trashed_at": null,
"type": "file"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get trashed folder
{{baseUrl}}/folders/:folder_id/trash
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/trash");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id/trash")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/trash"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/trash"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/trash");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/trash"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id/trash HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id/trash")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/trash"))
.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}}/folders/:folder_id/trash")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id/trash")
.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}}/folders/:folder_id/trash');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/folders/:folder_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/trash';
const options = {method: 'GET'};
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}}/folders/:folder_id/trash',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/trash")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/trash',
headers: {}
};
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}}/folders/:folder_id/trash'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id/trash');
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}}/folders/:folder_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/trash';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/trash"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id/trash" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/trash",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id/trash');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/trash');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/trash');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/trash' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/trash' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id/trash")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/trash"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/trash"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/trash")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id/trash') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/trash";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id/trash
http GET {{baseUrl}}/folders/:folder_id/trash
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id/trash
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/trash")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"etag": "1",
"folder_upload_email": null,
"id": "123456789",
"item_status": "trashed",
"modified_at": "2012-12-12T10:53:43-08:00",
"name": "Contracts",
"purged_at": "2012-12-12T10:53:43-08:00",
"shared_link": null,
"size": 629644,
"trashed_at": "2012-12-12T10:53:43-08:00",
"type": "folder"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Permanently remove folder
{{baseUrl}}/folders/:folder_id/trash
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/trash");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/folders/:folder_id/trash")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/trash"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/trash"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/trash");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/trash"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/folders/:folder_id/trash HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/folders/:folder_id/trash")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/trash"))
.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}}/folders/:folder_id/trash")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/folders/:folder_id/trash")
.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}}/folders/:folder_id/trash');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/folders/:folder_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/trash';
const options = {method: 'DELETE'};
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}}/folders/:folder_id/trash',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/trash")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/trash',
headers: {}
};
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}}/folders/:folder_id/trash'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/folders/:folder_id/trash');
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}}/folders/:folder_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/trash';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/trash"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/folders/:folder_id/trash" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/trash",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/folders/:folder_id/trash');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/trash');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/trash');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/trash' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/trash' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/folders/:folder_id/trash")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/trash"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/trash"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/trash")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/folders/:folder_id/trash') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/trash";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/folders/:folder_id/trash
http DELETE {{baseUrl}}/folders/:folder_id/trash
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/folders/:folder_id/trash
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/trash")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Restore folder
{{baseUrl}}/folders/:folder_id
QUERY PARAMS
folder_id
BODY json
{
"name": "",
"parent": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id");
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 \"name\": \"\",\n \"parent\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders/:folder_id" {:content-type :json
:form-params {:name ""
:parent ""}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"parent\": \"\"\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}}/folders/:folder_id"),
Content = new StringContent("{\n \"name\": \"\",\n \"parent\": \"\"\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}}/folders/:folder_id");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"parent\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id"
payload := strings.NewReader("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/folders/:folder_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 32
{
"name": "",
"parent": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders/:folder_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"parent\": \"\"\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 \"name\": \"\",\n \"parent\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/folders/:folder_id")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
.asString();
const data = JSON.stringify({
name: '',
parent: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folders/:folder_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id',
headers: {'content-type': 'application/json'},
data: {name: '', parent: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":""}'
};
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}}/folders/:folder_id',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "parent": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"parent\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.post(body)
.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/folders/:folder_id',
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({name: '', parent: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id',
headers: {'content-type': 'application/json'},
body: {name: '', parent: ''},
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}}/folders/:folder_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
parent: ''
});
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}}/folders/:folder_id',
headers: {'content-type': 'application/json'},
data: {name: '', parent: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":""}'
};
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 = @{ @"name": @"",
@"parent": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id"]
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}}/folders/:folder_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"parent\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id",
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' => '',
'parent' => ''
]),
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('POST', '{{baseUrl}}/folders/:folder_id', [
'body' => '{
"name": "",
"parent": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'parent' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'name' => '',
'parent' => ''
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id');
$request->setRequestMethod('POST');
$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}}/folders/:folder_id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"parent\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders/:folder_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id"
payload = {
"name": "",
"parent": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id"
payload <- "{\n \"name\": \"\",\n \"parent\": \"\"\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}}/folders/:folder_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"parent\": \"\"\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/folders/:folder_id') do |req|
req.body = "{\n \"name\": \"\",\n \"parent\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id";
let payload = json!({
"name": "",
"parent": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/folders/:folder_id \
--header 'content-type: application/json' \
--data '{
"name": "",
"parent": ""
}'
echo '{
"name": "",
"parent": ""
}' | \
http POST {{baseUrl}}/folders/:folder_id \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "parent": ""\n}' \
--output-document \
- {{baseUrl}}/folders/:folder_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"parent": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id")! 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
{
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"etag": "1",
"folder_upload_email": null,
"id": "123456789",
"item_status": "active",
"modified_at": "2012-12-12T10:53:43-08:00",
"name": "Contracts",
"purged_at": null,
"shared_link": null,
"size": 629644,
"trashed_at": null,
"type": "folder"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List trashed items
{{baseUrl}}/folders/trash/items
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/trash/items");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/trash/items")
require "http/client"
url = "{{baseUrl}}/folders/trash/items"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/trash/items"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/trash/items");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/trash/items"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/trash/items HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/trash/items")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/trash/items"))
.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}}/folders/trash/items")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/trash/items")
.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}}/folders/trash/items');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/folders/trash/items'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/trash/items';
const options = {method: 'GET'};
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}}/folders/trash/items',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/trash/items")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/trash/items',
headers: {}
};
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}}/folders/trash/items'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/trash/items');
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}}/folders/trash/items'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/trash/items';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/trash/items"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/trash/items" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/trash/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/trash/items');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/trash/items');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/trash/items');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/trash/items' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/trash/items' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/trash/items")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/trash/items"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/trash/items"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/trash/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/trash/items') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/trash/items";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/trash/items
http GET {{baseUrl}}/folders/trash/items
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/trash/items
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/trash/items")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get trashed web link
{{baseUrl}}/web_links/:web_link_id/trash
QUERY PARAMS
web_link_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id/trash");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/web_links/:web_link_id/trash")
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id/trash"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/web_links/:web_link_id/trash"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/web_links/:web_link_id/trash");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id/trash"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/web_links/:web_link_id/trash HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/web_links/:web_link_id/trash")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id/trash"))
.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}}/web_links/:web_link_id/trash")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/web_links/:web_link_id/trash")
.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}}/web_links/:web_link_id/trash');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/web_links/:web_link_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id/trash';
const options = {method: 'GET'};
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}}/web_links/:web_link_id/trash',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id/trash")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/web_links/:web_link_id/trash',
headers: {}
};
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}}/web_links/:web_link_id/trash'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/web_links/:web_link_id/trash');
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}}/web_links/:web_link_id/trash'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id/trash';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id/trash"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/web_links/:web_link_id/trash" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id/trash",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/web_links/:web_link_id/trash');
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id/trash');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/web_links/:web_link_id/trash');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/web_links/:web_link_id/trash' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id/trash' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/web_links/:web_link_id/trash")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id/trash"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id/trash"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id/trash")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/web_links/:web_link_id/trash') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/web_links/:web_link_id/trash";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/web_links/:web_link_id/trash
http GET {{baseUrl}}/web_links/:web_link_id/trash
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/web_links/:web_link_id/trash
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id/trash")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"created_at": "2012-12-12T10:53:43-08:00",
"description": "Example page",
"etag": "1",
"id": "11446498",
"item_status": "trashed",
"modified_at": "2012-12-12T10:53:43-08:00",
"name": "My Bookmark",
"purged_at": "2012-12-12T10:53:43-08:00",
"shared_link": null,
"trashed_at": "2012-12-12T10:53:43-08:00",
"type": "web_link",
"url": "https://www.example.com/example/1234"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Permanently remove web link
{{baseUrl}}/web_links/:web_link_id/trash
QUERY PARAMS
web_link_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id/trash");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/web_links/:web_link_id/trash")
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id/trash"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/web_links/:web_link_id/trash"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/web_links/:web_link_id/trash");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id/trash"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/web_links/:web_link_id/trash HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/web_links/:web_link_id/trash")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id/trash"))
.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}}/web_links/:web_link_id/trash")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/web_links/:web_link_id/trash")
.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}}/web_links/:web_link_id/trash');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/web_links/:web_link_id/trash'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id/trash';
const options = {method: 'DELETE'};
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}}/web_links/:web_link_id/trash',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id/trash")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/web_links/:web_link_id/trash',
headers: {}
};
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}}/web_links/:web_link_id/trash'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/web_links/:web_link_id/trash');
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}}/web_links/:web_link_id/trash'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id/trash';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id/trash"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/web_links/:web_link_id/trash" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id/trash",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/web_links/:web_link_id/trash');
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id/trash');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/web_links/:web_link_id/trash');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/web_links/:web_link_id/trash' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id/trash' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/web_links/:web_link_id/trash")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id/trash"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id/trash"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id/trash")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/web_links/:web_link_id/trash') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/web_links/:web_link_id/trash";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/web_links/:web_link_id/trash
http DELETE {{baseUrl}}/web_links/:web_link_id/trash
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/web_links/:web_link_id/trash
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id/trash")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Restore web link
{{baseUrl}}/web_links/:web_link_id
QUERY PARAMS
web_link_id
BODY json
{
"name": "",
"parent": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id");
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 \"name\": \"\",\n \"parent\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/web_links/:web_link_id" {:content-type :json
:form-params {:name ""
:parent ""}})
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"parent\": \"\"\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}}/web_links/:web_link_id"),
Content = new StringContent("{\n \"name\": \"\",\n \"parent\": \"\"\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}}/web_links/:web_link_id");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"parent\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id"
payload := strings.NewReader("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/web_links/:web_link_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 32
{
"name": "",
"parent": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/web_links/:web_link_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"parent\": \"\"\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 \"name\": \"\",\n \"parent\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/web_links/:web_link_id")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"parent\": \"\"\n}")
.asString();
const data = JSON.stringify({
name: '',
parent: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/web_links/:web_link_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/web_links/:web_link_id',
headers: {'content-type': 'application/json'},
data: {name: '', parent: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":""}'
};
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}}/web_links/:web_link_id',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "parent": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"parent\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id")
.post(body)
.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/web_links/:web_link_id',
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({name: '', parent: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/web_links/:web_link_id',
headers: {'content-type': 'application/json'},
body: {name: '', parent: ''},
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}}/web_links/:web_link_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
parent: ''
});
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}}/web_links/:web_link_id',
headers: {'content-type': 'application/json'},
data: {name: '', parent: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent":""}'
};
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 = @{ @"name": @"",
@"parent": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id"]
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}}/web_links/:web_link_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"parent\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id",
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' => '',
'parent' => ''
]),
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('POST', '{{baseUrl}}/web_links/:web_link_id', [
'body' => '{
"name": "",
"parent": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'parent' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'name' => '',
'parent' => ''
]));
$request->setRequestUrl('{{baseUrl}}/web_links/:web_link_id');
$request->setRequestMethod('POST');
$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}}/web_links/:web_link_id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"parent\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/web_links/:web_link_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id"
payload = {
"name": "",
"parent": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id"
payload <- "{\n \"name\": \"\",\n \"parent\": \"\"\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}}/web_links/:web_link_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"parent\": \"\"\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/web_links/:web_link_id') do |req|
req.body = "{\n \"name\": \"\",\n \"parent\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/web_links/:web_link_id";
let payload = json!({
"name": "",
"parent": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/web_links/:web_link_id \
--header 'content-type: application/json' \
--data '{
"name": "",
"parent": ""
}'
echo '{
"name": "",
"parent": ""
}' | \
http POST {{baseUrl}}/web_links/:web_link_id \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "parent": ""\n}' \
--output-document \
- {{baseUrl}}/web_links/:web_link_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"parent": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id")! 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
{
"created_at": "2012-12-12T10:53:43-08:00",
"description": "Example page",
"etag": "1",
"id": "11446498",
"item_status": "trashed",
"modified_at": "2012-12-12T10:53:43-08:00",
"name": "My Bookmark",
"purged_at": null,
"shared_link": null,
"trashed_at": null,
"type": "web_link",
"url": "https://www.example.com/example/1234"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Upload file version
{{baseUrl}}/files/:file_id/content
QUERY PARAMS
file_id
BODY multipartForm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/content");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id/content" {:multipart [{:name "attributes"
:content ""} {:name "file"
:content ""}]})
require "http/client"
url = "{{baseUrl}}/files/:file_id/content"
headers = HTTP::Headers{
"content-type" => "multipart/form-data; boundary=---011000010111000001101001"
}
reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\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}}/files/:file_id/content"),
Content = new MultipartFormDataContent
{
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "attributes",
}
}
},
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "file",
}
}
},
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/content");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/content"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id/content HTTP/1.1
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: example.com
Content-Length: 199
-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id/content")
.setHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.setBody("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/content"))
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.method("POST", HttpRequest.BodyPublishers.ofString("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/content")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id/content")
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.asString();
const data = new FormData();
data.append('attributes', '');
data.append('file', '');
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/:file_id/content');
xhr.send(data);
import axios from 'axios';
const form = new FormData();
form.append('attributes', '');
form.append('file', '');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/content',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '[form]'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/content';
const form = new FormData();
form.append('attributes', '');
form.append('file', '');
const options = {method: 'POST'};
options.body = form;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const form = new FormData();
form.append('attributes', '');
form.append('file', '');
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/files/:file_id/content',
method: 'POST',
headers: {},
processData: false,
contentType: false,
mimeType: 'multipart/form-data',
data: form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")
val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/content")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/content',
headers: {
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
}
};
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('-----011000010111000001101001\r\nContent-Disposition: form-data; name="attributes"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="file"\r\n\r\n\r\n-----011000010111000001101001--\r\n');
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/content',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
formData: {attributes: '', file: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/files/:file_id/content');
req.headers({
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
});
req.multipart([]);
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}}/files/:file_id/content',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '-----011000010111000001101001\r\nContent-Disposition: form-data; name="attributes"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="file"\r\n\r\n\r\n-----011000010111000001101001--\r\n'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();
formData.append('attributes', '');
formData.append('file', '');
const url = '{{baseUrl}}/files/:file_id/content';
const options = {method: 'POST'};
options.body = formData;
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": @"multipart/form-data; boundary=---011000010111000001101001" };
NSArray *parameters = @[ @{ @"name": @"attributes", @"value": @"" },
@{ @"name": @"file", @"value": @"" } ];
NSString *boundary = @"---011000010111000001101001";
NSError *error;
NSMutableString *body = [NSMutableString string];
for (NSDictionary *param in parameters) {
[body appendFormat:@"--%@\r\n", boundary];
if (param[@"fileName"]) {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"; filename=\"%@\"\r\n", param[@"name"], param[@"fileName"]];
[body appendFormat:@"Content-Type: %@\r\n\r\n", param[@"contentType"]];
[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];
if (error) {
NSLog(@"%@", error);
}
} else {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"\r\n\r\n", param[@"name"]];
[body appendFormat:@"%@", param[@"value"]];
}
}
[body appendFormat:@"\r\n--%@--\r\n", boundary];
NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/content"]
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}}/files/:file_id/content" in
let headers = Header.add (Header.init ()) "content-type" "multipart/form-data; boundary=---011000010111000001101001" in
let body = Cohttp_lwt_body.of_string "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/content",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n",
CURLOPT_HTTPHEADER => [
"content-type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/files/:file_id/content', [
'headers' => [
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/content');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
]);
$request->setBody('-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
addForm(null, null);
$request->setRequestUrl('{{baseUrl}}/files/:file_id/content');
$request->setRequestMethod('POST');
$request->setBody($body);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/content' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
'
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/content' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = { 'content-type': "multipart/form-data; boundary=---011000010111000001101001" }
conn.request("POST", "/baseUrl/files/:file_id/content", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/content"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"content-type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.post(url, data=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/content"
payload <- "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
encode <- "multipart"
response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/content")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001'}
)
response = conn.post('/baseUrl/files/:file_id/content') do |req|
req.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/content";
let form = reqwest::multipart::Form::new()
.text("attributes", "")
.text("file", "");
let mut headers = reqwest::header::HeaderMap::new();
let client = reqwest::Client::new();
let response = client.post(url)
.multipart(form)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/files/:file_id/content \
--header 'content-type: multipart/form-data' \
--form attributes= \
--form file=
echo '-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
' | \
http POST {{baseUrl}}/files/:file_id/content \
content-type:'multipart/form-data; boundary=---011000010111000001101001'
wget --quiet \
--method POST \
--header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
--body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="attributes"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="file"\r\n\r\n\r\n-----011000010111000001101001--\r\n' \
--output-document \
- {{baseUrl}}/files/:file_id/content
import Foundation
let headers = ["content-type": "multipart/form-data; boundary=---011000010111000001101001"]
let parameters = [
[
"name": "attributes",
"value": ""
],
[
"name": "file",
"value": ""
]
]
let boundary = "---011000010111000001101001"
var body = ""
var error: NSError? = nil
for param in parameters {
let paramName = param["name"]!
body += "--\(boundary)\r\n"
body += "Content-Disposition:form-data; name=\"\(paramName)\""
if let filename = param["fileName"] {
let contentType = param["content-type"]!
let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
if (error != nil) {
print(error as Any)
}
body += "; filename=\"\(filename)\"\r\n"
body += "Content-Type: \(contentType)\r\n\r\n"
body += fileContent
} else if let paramValue = param["value"] {
body += "\r\n\r\n\(paramValue)"
}
}
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/content")! 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
{
"total_count": 1
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Upload file
{{baseUrl}}/files/content
BODY multipartForm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/content");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/content" {:multipart [{:name "attributes"
:content ""} {:name "file"
:content ""}]})
require "http/client"
url = "{{baseUrl}}/files/content"
headers = HTTP::Headers{
"content-type" => "multipart/form-data; boundary=---011000010111000001101001"
}
reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\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}}/files/content"),
Content = new MultipartFormDataContent
{
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "attributes",
}
}
},
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "file",
}
}
},
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/content");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/content"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/content HTTP/1.1
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: example.com
Content-Length: 199
-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/content")
.setHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.setBody("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/content"))
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.method("POST", HttpRequest.BodyPublishers.ofString("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/content")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/content")
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.asString();
const data = new FormData();
data.append('attributes', '');
data.append('file', '');
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/content');
xhr.send(data);
import axios from 'axios';
const form = new FormData();
form.append('attributes', '');
form.append('file', '');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/content',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '[form]'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/content';
const form = new FormData();
form.append('attributes', '');
form.append('file', '');
const options = {method: 'POST'};
options.body = form;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const form = new FormData();
form.append('attributes', '');
form.append('file', '');
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/files/content',
method: 'POST',
headers: {},
processData: false,
contentType: false,
mimeType: 'multipart/form-data',
data: form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")
val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
val request = Request.Builder()
.url("{{baseUrl}}/files/content")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/content',
headers: {
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
}
};
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('-----011000010111000001101001\r\nContent-Disposition: form-data; name="attributes"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="file"\r\n\r\n\r\n-----011000010111000001101001--\r\n');
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/content',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
formData: {attributes: '', file: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/files/content');
req.headers({
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
});
req.multipart([]);
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}}/files/content',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '-----011000010111000001101001\r\nContent-Disposition: form-data; name="attributes"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="file"\r\n\r\n\r\n-----011000010111000001101001--\r\n'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();
formData.append('attributes', '');
formData.append('file', '');
const url = '{{baseUrl}}/files/content';
const options = {method: 'POST'};
options.body = formData;
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": @"multipart/form-data; boundary=---011000010111000001101001" };
NSArray *parameters = @[ @{ @"name": @"attributes", @"value": @"" },
@{ @"name": @"file", @"value": @"" } ];
NSString *boundary = @"---011000010111000001101001";
NSError *error;
NSMutableString *body = [NSMutableString string];
for (NSDictionary *param in parameters) {
[body appendFormat:@"--%@\r\n", boundary];
if (param[@"fileName"]) {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"; filename=\"%@\"\r\n", param[@"name"], param[@"fileName"]];
[body appendFormat:@"Content-Type: %@\r\n\r\n", param[@"contentType"]];
[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];
if (error) {
NSLog(@"%@", error);
}
} else {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"\r\n\r\n", param[@"name"]];
[body appendFormat:@"%@", param[@"value"]];
}
}
[body appendFormat:@"\r\n--%@--\r\n", boundary];
NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/content"]
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}}/files/content" in
let headers = Header.add (Header.init ()) "content-type" "multipart/form-data; boundary=---011000010111000001101001" in
let body = Cohttp_lwt_body.of_string "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/content",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n",
CURLOPT_HTTPHEADER => [
"content-type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/files/content', [
'headers' => [
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/content');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
]);
$request->setBody('-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
addForm(null, null);
$request->setRequestUrl('{{baseUrl}}/files/content');
$request->setRequestMethod('POST');
$request->setBody($body);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/content' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
'
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/content' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = { 'content-type': "multipart/form-data; boundary=---011000010111000001101001" }
conn.request("POST", "/baseUrl/files/content", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/content"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"content-type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.post(url, data=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/content"
payload <- "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
encode <- "multipart"
response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/content")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001'}
)
response = conn.post('/baseUrl/files/content') do |req|
req.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/content";
let form = reqwest::multipart::Form::new()
.text("attributes", "")
.text("file", "");
let mut headers = reqwest::header::HeaderMap::new();
let client = reqwest::Client::new();
let response = client.post(url)
.multipart(form)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/files/content \
--header 'content-type: multipart/form-data' \
--form attributes= \
--form file=
echo '-----011000010111000001101001
Content-Disposition: form-data; name="attributes"
-----011000010111000001101001
Content-Disposition: form-data; name="file"
-----011000010111000001101001--
' | \
http POST {{baseUrl}}/files/content \
content-type:'multipart/form-data; boundary=---011000010111000001101001'
wget --quiet \
--method POST \
--header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
--body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="attributes"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="file"\r\n\r\n\r\n-----011000010111000001101001--\r\n' \
--output-document \
- {{baseUrl}}/files/content
import Foundation
let headers = ["content-type": "multipart/form-data; boundary=---011000010111000001101001"]
let parameters = [
[
"name": "attributes",
"value": ""
],
[
"name": "file",
"value": ""
]
]
let boundary = "---011000010111000001101001"
var body = ""
var error: NSError? = nil
for param in parameters {
let paramName = param["name"]!
body += "--\(boundary)\r\n"
body += "Content-Disposition:form-data; name=\"\(paramName)\""
if let filename = param["fileName"] {
let contentType = param["content-type"]!
let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
if (error != nil) {
print(error as Any)
}
body += "; filename=\"\(filename)\"\r\n"
body += "Content-Type: \(contentType)\r\n\r\n"
body += fileContent
} else if let paramValue = param["value"] {
body += "\r\n\r\n\(paramValue)"
}
}
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/content")! 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
{
"total_count": 1
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Commit upload session
{{baseUrl}}/files/upload_sessions/:upload_session_id/commit
HEADERS
digest
QUERY PARAMS
upload_session_id
BODY json
{
"parts": [
{}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "digest: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"parts\": [\n {}\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit" {:headers {:digest ""}
:content-type :json
:form-params {:parts [{}]}})
require "http/client"
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit"
headers = HTTP::Headers{
"digest" => ""
"content-type" => "application/json"
}
reqBody = "{\n \"parts\": [\n {}\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}}/files/upload_sessions/:upload_session_id/commit"),
Headers =
{
{ "digest", "" },
},
Content = new StringContent("{\n \"parts\": [\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}}/files/upload_sessions/:upload_session_id/commit");
var request = new RestRequest("", Method.Post);
request.AddHeader("digest", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"parts\": [\n {}\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit"
payload := strings.NewReader("{\n \"parts\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("digest", "")
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/files/upload_sessions/:upload_session_id/commit HTTP/1.1
Digest:
Content-Type: application/json
Host: example.com
Content-Length: 27
{
"parts": [
{}
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit")
.setHeader("digest", "")
.setHeader("content-type", "application/json")
.setBody("{\n \"parts\": [\n {}\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/upload_sessions/:upload_session_id/commit"))
.header("digest", "")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"parts\": [\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 \"parts\": [\n {}\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/upload_sessions/:upload_session_id/commit")
.post(body)
.addHeader("digest", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/upload_sessions/:upload_session_id/commit")
.header("digest", "")
.header("content-type", "application/json")
.body("{\n \"parts\": [\n {}\n ]\n}")
.asString();
const data = JSON.stringify({
parts: [
{}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit');
xhr.setRequestHeader('digest', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit',
headers: {digest: '', 'content-type': 'application/json'},
data: {parts: [{}]}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit';
const options = {
method: 'POST',
headers: {digest: '', 'content-type': 'application/json'},
body: '{"parts":[{}]}'
};
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}}/files/upload_sessions/:upload_session_id/commit',
method: 'POST',
headers: {
digest: '',
'content-type': 'application/json'
},
processData: false,
data: '{\n "parts": [\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 \"parts\": [\n {}\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/upload_sessions/:upload_session_id/commit")
.post(body)
.addHeader("digest", "")
.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/files/upload_sessions/:upload_session_id/commit',
headers: {
digest: '',
'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({parts: [{}]}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit',
headers: {digest: '', 'content-type': 'application/json'},
body: {parts: [{}]},
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}}/files/upload_sessions/:upload_session_id/commit');
req.headers({
digest: '',
'content-type': 'application/json'
});
req.type('json');
req.send({
parts: [
{}
]
});
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}}/files/upload_sessions/:upload_session_id/commit',
headers: {digest: '', 'content-type': 'application/json'},
data: {parts: [{}]}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit';
const options = {
method: 'POST',
headers: {digest: '', 'content-type': 'application/json'},
body: '{"parts":[{}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"digest": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"parts": @[ @{ } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/upload_sessions/:upload_session_id/commit"]
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}}/files/upload_sessions/:upload_session_id/commit" in
let headers = Header.add_list (Header.init ()) [
("digest", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"parts\": [\n {}\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/upload_sessions/:upload_session_id/commit",
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([
'parts' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json",
"digest: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit', [
'body' => '{
"parts": [
{}
]
}',
'headers' => [
'content-type' => 'application/json',
'digest' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id/commit');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'digest' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'parts' => [
[
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'parts' => [
[
]
]
]));
$request->setRequestUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id/commit');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'digest' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("digest", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"parts": [
{}
]
}'
$headers=@{}
$headers.Add("digest", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id/commit' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"parts": [
{}
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"parts\": [\n {}\n ]\n}"
headers = {
'digest': "",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/files/upload_sessions/:upload_session_id/commit", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit"
payload = { "parts": [{}] }
headers = {
"digest": "",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit"
payload <- "{\n \"parts\": [\n {}\n ]\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('digest' = ''), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/upload_sessions/:upload_session_id/commit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["digest"] = ''
request["content-type"] = 'application/json'
request.body = "{\n \"parts\": [\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.post('/baseUrl/files/upload_sessions/:upload_session_id/commit') do |req|
req.headers['digest'] = ''
req.body = "{\n \"parts\": [\n {}\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit";
let payload = json!({"parts": (json!({}))});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("digest", "".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}}/files/upload_sessions/:upload_session_id/commit \
--header 'content-type: application/json' \
--header 'digest: ' \
--data '{
"parts": [
{}
]
}'
echo '{
"parts": [
{}
]
}' | \
http POST {{baseUrl}}/files/upload_sessions/:upload_session_id/commit \
content-type:application/json \
digest:''
wget --quiet \
--method POST \
--header 'digest: ' \
--header 'content-type: application/json' \
--body-data '{\n "parts": [\n {}\n ]\n}' \
--output-document \
- {{baseUrl}}/files/upload_sessions/:upload_session_id/commit
import Foundation
let headers = [
"digest": "",
"content-type": "application/json"
]
let parameters = ["parts": [[]]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit")! 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
{
"total_count": 1
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create upload session for existing file
{{baseUrl}}/files/:file_id/upload_sessions
QUERY PARAMS
file_id
BODY json
{
"file_name": "",
"file_size": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/upload_sessions");
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 \"file_name\": \"\",\n \"file_size\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/:file_id/upload_sessions" {:content-type :json
:form-params {:file_name ""
:file_size 0}})
require "http/client"
url = "{{baseUrl}}/files/:file_id/upload_sessions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"file_name\": \"\",\n \"file_size\": 0\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}}/files/:file_id/upload_sessions"),
Content = new StringContent("{\n \"file_name\": \"\",\n \"file_size\": 0\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}}/files/:file_id/upload_sessions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"file_name\": \"\",\n \"file_size\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/upload_sessions"
payload := strings.NewReader("{\n \"file_name\": \"\",\n \"file_size\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/:file_id/upload_sessions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 39
{
"file_name": "",
"file_size": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/:file_id/upload_sessions")
.setHeader("content-type", "application/json")
.setBody("{\n \"file_name\": \"\",\n \"file_size\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/upload_sessions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"file_name\": \"\",\n \"file_size\": 0\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 \"file_name\": \"\",\n \"file_size\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/upload_sessions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/:file_id/upload_sessions")
.header("content-type", "application/json")
.body("{\n \"file_name\": \"\",\n \"file_size\": 0\n}")
.asString();
const data = JSON.stringify({
file_name: '',
file_size: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/:file_id/upload_sessions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/upload_sessions',
headers: {'content-type': 'application/json'},
data: {file_name: '', file_size: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/upload_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"file_name":"","file_size":0}'
};
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}}/files/:file_id/upload_sessions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "file_name": "",\n "file_size": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"file_name\": \"\",\n \"file_size\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/upload_sessions")
.post(body)
.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/files/:file_id/upload_sessions',
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({file_name: '', file_size: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/:file_id/upload_sessions',
headers: {'content-type': 'application/json'},
body: {file_name: '', file_size: 0},
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}}/files/:file_id/upload_sessions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
file_name: '',
file_size: 0
});
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}}/files/:file_id/upload_sessions',
headers: {'content-type': 'application/json'},
data: {file_name: '', file_size: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/upload_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"file_name":"","file_size":0}'
};
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 = @{ @"file_name": @"",
@"file_size": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/upload_sessions"]
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}}/files/:file_id/upload_sessions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"file_name\": \"\",\n \"file_size\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/upload_sessions",
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([
'file_name' => '',
'file_size' => 0
]),
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('POST', '{{baseUrl}}/files/:file_id/upload_sessions', [
'body' => '{
"file_name": "",
"file_size": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/upload_sessions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'file_name' => '',
'file_size' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'file_name' => '',
'file_size' => 0
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id/upload_sessions');
$request->setRequestMethod('POST');
$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}}/files/:file_id/upload_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"file_name": "",
"file_size": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/upload_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"file_name": "",
"file_size": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"file_name\": \"\",\n \"file_size\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/:file_id/upload_sessions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/upload_sessions"
payload = {
"file_name": "",
"file_size": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/upload_sessions"
payload <- "{\n \"file_name\": \"\",\n \"file_size\": 0\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}}/files/:file_id/upload_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"file_name\": \"\",\n \"file_size\": 0\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/files/:file_id/upload_sessions') do |req|
req.body = "{\n \"file_name\": \"\",\n \"file_size\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/upload_sessions";
let payload = json!({
"file_name": "",
"file_size": 0
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/:file_id/upload_sessions \
--header 'content-type: application/json' \
--data '{
"file_name": "",
"file_size": 0
}'
echo '{
"file_name": "",
"file_size": 0
}' | \
http POST {{baseUrl}}/files/:file_id/upload_sessions \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "file_name": "",\n "file_size": 0\n}' \
--output-document \
- {{baseUrl}}/files/:file_id/upload_sessions
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"file_name": "",
"file_size": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/upload_sessions")! 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
{
"id": "F971964745A5CD0C001BBE4E58196BFD",
"num_parts_processed": 455,
"part_size": 1024,
"session_expires_at": "2012-12-12T10:53:43-08:00",
"total_parts": 1000,
"type": "upload_session"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create upload session
{{baseUrl}}/files/upload_sessions
BODY json
{
"file_name": "",
"file_size": 0,
"folder_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/upload_sessions");
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 \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/files/upload_sessions" {:content-type :json
:form-params {:file_name ""
:file_size 0
:folder_id ""}})
require "http/client"
url = "{{baseUrl}}/files/upload_sessions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\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}}/files/upload_sessions"),
Content = new StringContent("{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\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}}/files/upload_sessions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/upload_sessions"
payload := strings.NewReader("{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/files/upload_sessions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 58
{
"file_name": "",
"file_size": 0,
"folder_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/files/upload_sessions")
.setHeader("content-type", "application/json")
.setBody("{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/upload_sessions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\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 \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/upload_sessions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/files/upload_sessions")
.header("content-type", "application/json")
.body("{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
file_name: '',
file_size: 0,
folder_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/files/upload_sessions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/files/upload_sessions',
headers: {'content-type': 'application/json'},
data: {file_name: '', file_size: 0, folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/upload_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"file_name":"","file_size":0,"folder_id":""}'
};
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}}/files/upload_sessions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "file_name": "",\n "file_size": 0,\n "folder_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/upload_sessions")
.post(body)
.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/files/upload_sessions',
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({file_name: '', file_size: 0, folder_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/files/upload_sessions',
headers: {'content-type': 'application/json'},
body: {file_name: '', file_size: 0, folder_id: ''},
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}}/files/upload_sessions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
file_name: '',
file_size: 0,
folder_id: ''
});
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}}/files/upload_sessions',
headers: {'content-type': 'application/json'},
data: {file_name: '', file_size: 0, folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/upload_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"file_name":"","file_size":0,"folder_id":""}'
};
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 = @{ @"file_name": @"",
@"file_size": @0,
@"folder_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/upload_sessions"]
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}}/files/upload_sessions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/upload_sessions",
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([
'file_name' => '',
'file_size' => 0,
'folder_id' => ''
]),
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('POST', '{{baseUrl}}/files/upload_sessions', [
'body' => '{
"file_name": "",
"file_size": 0,
"folder_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/upload_sessions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'file_name' => '',
'file_size' => 0,
'folder_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'file_name' => '',
'file_size' => 0,
'folder_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/files/upload_sessions');
$request->setRequestMethod('POST');
$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}}/files/upload_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"file_name": "",
"file_size": 0,
"folder_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/upload_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"file_name": "",
"file_size": 0,
"folder_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/files/upload_sessions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/upload_sessions"
payload = {
"file_name": "",
"file_size": 0,
"folder_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/upload_sessions"
payload <- "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\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}}/files/upload_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\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/files/upload_sessions') do |req|
req.body = "{\n \"file_name\": \"\",\n \"file_size\": 0,\n \"folder_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/upload_sessions";
let payload = json!({
"file_name": "",
"file_size": 0,
"folder_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/files/upload_sessions \
--header 'content-type: application/json' \
--data '{
"file_name": "",
"file_size": 0,
"folder_id": ""
}'
echo '{
"file_name": "",
"file_size": 0,
"folder_id": ""
}' | \
http POST {{baseUrl}}/files/upload_sessions \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "file_name": "",\n "file_size": 0,\n "folder_id": ""\n}' \
--output-document \
- {{baseUrl}}/files/upload_sessions
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"file_name": "",
"file_size": 0,
"folder_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/upload_sessions")! 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
{
"id": "F971964745A5CD0C001BBE4E58196BFD",
"num_parts_processed": 455,
"part_size": 1024,
"session_expires_at": "2012-12-12T10:53:43-08:00",
"total_parts": 1000,
"type": "upload_session"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get upload session
{{baseUrl}}/files/upload_sessions/:upload_session_id
QUERY PARAMS
upload_session_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/upload_sessions/:upload_session_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/upload_sessions/:upload_session_id")
require "http/client"
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/upload_sessions/:upload_session_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/upload_sessions/:upload_session_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/upload_sessions/:upload_session_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/upload_sessions/:upload_session_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/upload_sessions/:upload_session_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/upload_sessions/:upload_session_id"))
.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}}/files/upload_sessions/:upload_session_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/upload_sessions/:upload_session_id")
.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}}/files/upload_sessions/:upload_session_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id';
const options = {method: 'GET'};
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}}/files/upload_sessions/:upload_session_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/upload_sessions/:upload_session_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/upload_sessions/:upload_session_id',
headers: {}
};
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}}/files/upload_sessions/:upload_session_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/upload_sessions/:upload_session_id');
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}}/files/upload_sessions/:upload_session_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/upload_sessions/:upload_session_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/upload_sessions/:upload_session_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/upload_sessions/:upload_session_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/upload_sessions/:upload_session_id');
echo $response->getBody();
setUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/upload_sessions/:upload_session_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/upload_sessions/:upload_session_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/upload_sessions/:upload_session_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/upload_sessions/:upload_session_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/upload_sessions/:upload_session_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/upload_sessions/:upload_session_id
http GET {{baseUrl}}/files/upload_sessions/:upload_session_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/upload_sessions/:upload_session_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/upload_sessions/:upload_session_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"id": "F971964745A5CD0C001BBE4E58196BFD",
"num_parts_processed": 455,
"part_size": 1024,
"session_expires_at": "2012-12-12T10:53:43-08:00",
"total_parts": 1000,
"type": "upload_session"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List parts
{{baseUrl}}/files/upload_sessions/:upload_session_id/parts
QUERY PARAMS
upload_session_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts")
require "http/client"
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/upload_sessions/:upload_session_id/parts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/upload_sessions/:upload_session_id/parts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/upload_sessions/:upload_session_id/parts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/upload_sessions/:upload_session_id/parts"))
.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}}/files/upload_sessions/:upload_session_id/parts")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/upload_sessions/:upload_session_id/parts")
.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}}/files/upload_sessions/:upload_session_id/parts');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id/parts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id/parts';
const options = {method: 'GET'};
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}}/files/upload_sessions/:upload_session_id/parts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/upload_sessions/:upload_session_id/parts")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/upload_sessions/:upload_session_id/parts',
headers: {}
};
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}}/files/upload_sessions/:upload_session_id/parts'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/upload_sessions/:upload_session_id/parts');
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}}/files/upload_sessions/:upload_session_id/parts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id/parts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/upload_sessions/:upload_session_id/parts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/upload_sessions/:upload_session_id/parts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/upload_sessions/:upload_session_id/parts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/upload_sessions/:upload_session_id/parts');
echo $response->getBody();
setUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id/parts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id/parts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id/parts' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id/parts' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/upload_sessions/:upload_session_id/parts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/upload_sessions/:upload_session_id/parts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/upload_sessions/:upload_session_id/parts') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/upload_sessions/:upload_session_id/parts
http GET {{baseUrl}}/files/upload_sessions/:upload_session_id/parts
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/upload_sessions/:upload_session_id/parts
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove upload session
{{baseUrl}}/files/upload_sessions/:upload_session_id
QUERY PARAMS
upload_session_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/upload_sessions/:upload_session_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/upload_sessions/:upload_session_id")
require "http/client"
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/upload_sessions/:upload_session_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/upload_sessions/:upload_session_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/upload_sessions/:upload_session_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/upload_sessions/:upload_session_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/upload_sessions/:upload_session_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/upload_sessions/:upload_session_id"))
.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}}/files/upload_sessions/:upload_session_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/upload_sessions/:upload_session_id")
.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}}/files/upload_sessions/:upload_session_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id';
const options = {method: 'DELETE'};
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}}/files/upload_sessions/:upload_session_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/upload_sessions/:upload_session_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/upload_sessions/:upload_session_id',
headers: {}
};
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}}/files/upload_sessions/:upload_session_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/upload_sessions/:upload_session_id');
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}}/files/upload_sessions/:upload_session_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/upload_sessions/:upload_session_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/upload_sessions/:upload_session_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/upload_sessions/:upload_session_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/upload_sessions/:upload_session_id');
echo $response->getBody();
setUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/upload_sessions/:upload_session_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/upload_sessions/:upload_session_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/upload_sessions/:upload_session_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/upload_sessions/:upload_session_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/upload_sessions/:upload_session_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/upload_sessions/:upload_session_id
http DELETE {{baseUrl}}/files/upload_sessions/:upload_session_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/upload_sessions/:upload_session_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/upload_sessions/:upload_session_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Upload part of file
{{baseUrl}}/files/upload_sessions/:upload_session_id
HEADERS
digest
content-range
QUERY PARAMS
upload_session_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/upload_sessions/:upload_session_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "digest: ");
headers = curl_slist_append(headers, "content-range: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/upload_sessions/:upload_session_id" {:headers {:digest ""
:content-range ""}})
require "http/client"
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id"
headers = HTTP::Headers{
"digest" => ""
"content-range" => ""
}
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}}/files/upload_sessions/:upload_session_id"),
Headers =
{
{ "digest", "" },
{ "content-range", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/upload_sessions/:upload_session_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("digest", "");
request.AddHeader("content-range", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/upload_sessions/:upload_session_id"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("digest", "")
req.Header.Add("content-range", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/files/upload_sessions/:upload_session_id HTTP/1.1
Digest:
Content-Range:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/upload_sessions/:upload_session_id")
.setHeader("digest", "")
.setHeader("content-range", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/upload_sessions/:upload_session_id"))
.header("digest", "")
.header("content-range", "")
.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}}/files/upload_sessions/:upload_session_id")
.put(null)
.addHeader("digest", "")
.addHeader("content-range", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/upload_sessions/:upload_session_id")
.header("digest", "")
.header("content-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('PUT', '{{baseUrl}}/files/upload_sessions/:upload_session_id');
xhr.setRequestHeader('digest', '');
xhr.setRequestHeader('content-range', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id',
headers: {digest: '', 'content-range': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id';
const options = {method: 'PUT', headers: {digest: '', 'content-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}}/files/upload_sessions/:upload_session_id',
method: 'PUT',
headers: {
digest: '',
'content-range': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/upload_sessions/:upload_session_id")
.put(null)
.addHeader("digest", "")
.addHeader("content-range", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/upload_sessions/:upload_session_id',
headers: {
digest: '',
'content-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: 'PUT',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id',
headers: {digest: '', 'content-range': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/files/upload_sessions/:upload_session_id');
req.headers({
digest: '',
'content-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: 'PUT',
url: '{{baseUrl}}/files/upload_sessions/:upload_session_id',
headers: {digest: '', 'content-range': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/upload_sessions/:upload_session_id';
const options = {method: 'PUT', headers: {digest: '', 'content-range': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"digest": @"",
@"content-range": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/upload_sessions/:upload_session_id"]
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}}/files/upload_sessions/:upload_session_id" in
let headers = Header.add_list (Header.init ()) [
("digest", "");
("content-range", "");
] in
Client.call ~headers `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/upload_sessions/:upload_session_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"content-range: ",
"digest: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/files/upload_sessions/:upload_session_id', [
'headers' => [
'content-range' => '',
'digest' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'digest' => '',
'content-range' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/upload_sessions/:upload_session_id');
$request->setRequestMethod('PUT');
$request->setHeaders([
'digest' => '',
'content-range' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("digest", "")
$headers.Add("content-range", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id' -Method PUT -Headers $headers
$headers=@{}
$headers.Add("digest", "")
$headers.Add("content-range", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/upload_sessions/:upload_session_id' -Method PUT -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = {
'digest': "",
'content-range': ""
}
conn.request("PUT", "/baseUrl/files/upload_sessions/:upload_session_id", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/upload_sessions/:upload_session_id"
headers = {
"digest": "",
"content-range": ""
}
response = requests.put(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/upload_sessions/:upload_session_id"
response <- VERB("PUT", url, add_headers('digest' = '', 'content-range' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/upload_sessions/:upload_session_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["digest"] = ''
request["content-range"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/files/upload_sessions/:upload_session_id') do |req|
req.headers['digest'] = ''
req.headers['content-range'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/upload_sessions/:upload_session_id";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("digest", "".parse().unwrap());
headers.insert("content-range", "".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}}/files/upload_sessions/:upload_session_id \
--header 'content-range: ' \
--header 'digest: '
http PUT {{baseUrl}}/files/upload_sessions/:upload_session_id \
content-range:'' \
digest:''
wget --quiet \
--method PUT \
--header 'digest: ' \
--header 'content-range: ' \
--output-document \
- {{baseUrl}}/files/upload_sessions/:upload_session_id
import Foundation
let headers = [
"digest": "",
"content-range": ""
]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/upload_sessions/:upload_session_id")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Add or update user avatar
{{baseUrl}}/users/:user_id/avatar
QUERY PARAMS
user_id
BODY multipartForm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/avatar");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/:user_id/avatar" {:multipart [{:name "pic"
:content ""}]})
require "http/client"
url = "{{baseUrl}}/users/:user_id/avatar"
headers = HTTP::Headers{
"content-type" => "multipart/form-data; boundary=---011000010111000001101001"
}
reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\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}}/users/:user_id/avatar"),
Content = new MultipartFormDataContent
{
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "pic",
}
}
},
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id/avatar");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/avatar"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/users/:user_id/avatar HTTP/1.1
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: example.com
Content-Length: 112
-----011000010111000001101001
Content-Disposition: form-data; name="pic"
-----011000010111000001101001--
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/:user_id/avatar")
.setHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.setBody("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/avatar"))
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.method("POST", HttpRequest.BodyPublishers.ofString("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:user_id/avatar")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/users/:user_id/avatar")
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.asString();
const data = new FormData();
data.append('pic', '');
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/:user_id/avatar');
xhr.send(data);
import axios from 'axios';
const form = new FormData();
form.append('pic', '');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:user_id/avatar',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '[form]'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/avatar';
const form = new FormData();
form.append('pic', '');
const options = {method: 'POST'};
options.body = form;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const form = new FormData();
form.append('pic', '');
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:user_id/avatar',
method: 'POST',
headers: {},
processData: false,
contentType: false,
mimeType: 'multipart/form-data',
data: form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")
val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/avatar")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id/avatar',
headers: {
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
}
};
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('-----011000010111000001101001\r\nContent-Disposition: form-data; name="pic"\r\n\r\n\r\n-----011000010111000001101001--\r\n');
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:user_id/avatar',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
formData: {pic: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/users/:user_id/avatar');
req.headers({
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
});
req.multipart([]);
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}}/users/:user_id/avatar',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '-----011000010111000001101001\r\nContent-Disposition: form-data; name="pic"\r\n\r\n\r\n-----011000010111000001101001--\r\n'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();
formData.append('pic', '');
const url = '{{baseUrl}}/users/:user_id/avatar';
const options = {method: 'POST'};
options.body = formData;
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": @"multipart/form-data; boundary=---011000010111000001101001" };
NSArray *parameters = @[ @{ @"name": @"pic", @"value": @"" } ];
NSString *boundary = @"---011000010111000001101001";
NSError *error;
NSMutableString *body = [NSMutableString string];
for (NSDictionary *param in parameters) {
[body appendFormat:@"--%@\r\n", boundary];
if (param[@"fileName"]) {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"; filename=\"%@\"\r\n", param[@"name"], param[@"fileName"]];
[body appendFormat:@"Content-Type: %@\r\n\r\n", param[@"contentType"]];
[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];
if (error) {
NSLog(@"%@", error);
}
} else {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"\r\n\r\n", param[@"name"]];
[body appendFormat:@"%@", param[@"value"]];
}
}
[body appendFormat:@"\r\n--%@--\r\n", boundary];
NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/avatar"]
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}}/users/:user_id/avatar" in
let headers = Header.add (Header.init ()) "content-type" "multipart/form-data; boundary=---011000010111000001101001" in
let body = Cohttp_lwt_body.of_string "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/avatar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n",
CURLOPT_HTTPHEADER => [
"content-type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/users/:user_id/avatar', [
'headers' => [
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/avatar');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
]);
$request->setBody('-----011000010111000001101001
Content-Disposition: form-data; name="pic"
-----011000010111000001101001--
');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
addForm(null, null);
$request->setRequestUrl('{{baseUrl}}/users/:user_id/avatar');
$request->setRequestMethod('POST');
$request->setBody($body);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id/avatar' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="pic"
-----011000010111000001101001--
'
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/avatar' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="pic"
-----011000010111000001101001--
'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = { 'content-type': "multipart/form-data; boundary=---011000010111000001101001" }
conn.request("POST", "/baseUrl/users/:user_id/avatar", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/avatar"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"content-type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.post(url, data=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/avatar"
payload <- "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
encode <- "multipart"
response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id/avatar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001'}
)
response = conn.post('/baseUrl/users/:user_id/avatar') do |req|
req.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pic\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id/avatar";
let form = reqwest::multipart::Form::new()
.text("pic", "");
let mut headers = reqwest::header::HeaderMap::new();
let client = reqwest::Client::new();
let response = client.post(url)
.multipart(form)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/users/:user_id/avatar \
--header 'content-type: multipart/form-data' \
--form pic=
echo '-----011000010111000001101001
Content-Disposition: form-data; name="pic"
-----011000010111000001101001--
' | \
http POST {{baseUrl}}/users/:user_id/avatar \
content-type:'multipart/form-data; boundary=---011000010111000001101001'
wget --quiet \
--method POST \
--header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
--body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="pic"\r\n\r\n\r\n-----011000010111000001101001--\r\n' \
--output-document \
- {{baseUrl}}/users/:user_id/avatar
import Foundation
let headers = ["content-type": "multipart/form-data; boundary=---011000010111000001101001"]
let parameters = [
[
"name": "pic",
"value": ""
]
]
let boundary = "---011000010111000001101001"
var body = ""
var error: NSError? = nil
for param in parameters {
let paramName = param["name"]!
body += "--\(boundary)\r\n"
body += "Content-Disposition:form-data; name=\"\(paramName)\""
if let filename = param["fileName"] {
let contentType = param["content-type"]!
let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
if (error != nil) {
print(error as Any)
}
body += "; filename=\"\(filename)\"\r\n"
body += "Content-Type: \(contentType)\r\n\r\n"
body += fileContent
} else if let paramValue = param["value"] {
body += "\r\n\r\n\(paramValue)"
}
}
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/avatar")! 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
{
"pic_urls": {
"large": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks pac3kv01!lipGQlQQOtCTCoB6zCOArUjVWLFJtLr5tn6aOZMCybhRx0NNuFQbVI36nw jtEk5YjUUz1KVdVuvU2yDhu_ftK_bvxeKP1Ffrx9vKGVvJ-UJc1z32p6n2CmFzzpc gSoX4pnPhFgydAL-u9jDspXUGElr-htDG_HPMiE9DZjqDueOxXHy8xe22wbaPAheC ao1emv8r_fmufaUgSndeMYmyZj-KqOYsLBrBNgdeiK5tZmPOQggAEUmyQPkrd8W92TQ6sSlIp0r",
"preview": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!8UcNPweOOAWj2DtHk_dCQB4wJpzyPkl7mT5nHj5ZdjY92ejYCBBZc95--403b29CW k-8hSo_uBjh5h9QG42Ihu-cOZ-816sej1kof3SOm5gjn7qjMAx89cHjUaNK-6XasRqSNboenjZ 04laZuV9vSH12BZGAYycIZvvQ5R66Go8xG5GTMARf2nBU84c4H_SL5iws-HeBS4oQJWOJh6FBl sSJDSTI74LGXqeZb3EY_As34VFC95F10uozoTOSubZmPYylPlaKXoKWk2f9wYQso1ZTN7sh-Gc 9Kp43zMLhArIWhok0Im6FlRAuWOQ03KYgL-k4L5EZp4Gw6B7uqVRwcBbsTwMIorWq1g",
"small": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!7B6R5cZLmurEV_xB-KkycPk8Oi7oENUX2O_qUtIuO4342CG IldyCto9hqiQP7uxqYU5V2w63Ft4ln4UVVLDtDZu903OqzkflY2O-Lq00 ubA29xU-RJ6b_KzJEWRYgUhX1zEl3dzWo12g8eWRE2rStf123DF7AYahNqM 1BmLmviL_nODc7SDQHedTXPAjxURUAra5BvtLe7B05AizbNXdPlCNp-LNh _S-eZ_RjDXcGO-MkRWd_3BOMHnvjf450t5BfKoJ15WhEfiMlfXH1tmouHXrsC 66cT6-pzF9E40Iir_zThqSlrFxzP_xcmXzHapr_k-0E2qr2TXp4iC396TSlEw"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"pic_urls": {
"large": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks pac3kv01!lipGQlQQOtCTCoB6zCOArUjVWLFJtLr5tn6aOZMCybhRx0NNuFQbVI36nw jtEk5YjUUz1KVdVuvU2yDhu_ftK_bvxeKP1Ffrx9vKGVvJ-UJc1z32p6n2CmFzzpc gSoX4pnPhFgydAL-u9jDspXUGElr-htDG_HPMiE9DZjqDueOxXHy8xe22wbaPAheC ao1emv8r_fmufaUgSndeMYmyZj-KqOYsLBrBNgdeiK5tZmPOQggAEUmyQPkrd8W92TQ6sSlIp0r",
"preview": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!8UcNPweOOAWj2DtHk_dCQB4wJpzyPkl7mT5nHj5ZdjY92ejYCBBZc95--403b29CW k-8hSo_uBjh5h9QG42Ihu-cOZ-816sej1kof3SOm5gjn7qjMAx89cHjUaNK-6XasRqSNboenjZ 04laZuV9vSH12BZGAYycIZvvQ5R66Go8xG5GTMARf2nBU84c4H_SL5iws-HeBS4oQJWOJh6FBl sSJDSTI74LGXqeZb3EY_As34VFC95F10uozoTOSubZmPYylPlaKXoKWk2f9wYQso1ZTN7sh-Gc 9Kp43zMLhArIWhok0Im6FlRAuWOQ03KYgL-k4L5EZp4Gw6B7uqVRwcBbsTwMIorWq1g",
"small": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!7B6R5cZLmurEV_xB-KkycPk8Oi7oENUX2O_qUtIuO4342CG IldyCto9hqiQP7uxqYU5V2w63Ft4ln4UVVLDtDZu903OqzkflY2O-Lq00 ubA29xU-RJ6b_KzJEWRYgUhX1zEl3dzWo12g8eWRE2rStf123DF7AYahNqM 1BmLmviL_nODc7SDQHedTXPAjxURUAra5BvtLe7B05AizbNXdPlCNp-LNh _S-eZ_RjDXcGO-MkRWd_3BOMHnvjf450t5BfKoJ15WhEfiMlfXH1tmouHXrsC 66cT6-pzF9E40Iir_zThqSlrFxzP_xcmXzHapr_k-0E2qr2TXp4iC396TSlEw"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete user avatar
{{baseUrl}}/users/:user_id/avatar
QUERY PARAMS
user_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/avatar");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/users/:user_id/avatar")
require "http/client"
url = "{{baseUrl}}/users/:user_id/avatar"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/users/:user_id/avatar"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id/avatar");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/avatar"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/users/:user_id/avatar HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/users/:user_id/avatar")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/avatar"))
.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}}/users/:user_id/avatar")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/users/:user_id/avatar")
.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}}/users/:user_id/avatar');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/users/:user_id/avatar'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/avatar';
const options = {method: 'DELETE'};
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}}/users/:user_id/avatar',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/avatar")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id/avatar',
headers: {}
};
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}}/users/:user_id/avatar'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/users/:user_id/avatar');
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}}/users/:user_id/avatar'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id/avatar';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/avatar"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/users/:user_id/avatar" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/avatar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/users/:user_id/avatar');
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/avatar');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/:user_id/avatar');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id/avatar' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/avatar' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/users/:user_id/avatar")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/avatar"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/avatar"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id/avatar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/users/:user_id/avatar') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id/avatar";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/users/:user_id/avatar
http DELETE {{baseUrl}}/users/:user_id/avatar
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/users/:user_id/avatar
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/avatar")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get user avatar
{{baseUrl}}/users/:user_id/avatar
QUERY PARAMS
user_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id/avatar");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:user_id/avatar")
require "http/client"
url = "{{baseUrl}}/users/:user_id/avatar"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:user_id/avatar"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id/avatar");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id/avatar"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/:user_id/avatar HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:user_id/avatar")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id/avatar"))
.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}}/users/:user_id/avatar")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/:user_id/avatar")
.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}}/users/:user_id/avatar');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:user_id/avatar'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id/avatar';
const options = {method: 'GET'};
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}}/users/:user_id/avatar',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id/avatar")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id/avatar',
headers: {}
};
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}}/users/:user_id/avatar'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:user_id/avatar');
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}}/users/:user_id/avatar'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id/avatar';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id/avatar"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/:user_id/avatar" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id/avatar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/users/:user_id/avatar');
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id/avatar');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/:user_id/avatar');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id/avatar' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id/avatar' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:user_id/avatar")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id/avatar"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id/avatar"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id/avatar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:user_id/avatar') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id/avatar";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:user_id/avatar
http GET {{baseUrl}}/users/:user_id/avatar
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:user_id/avatar
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id/avatar")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create jobs to terminate users session
{{baseUrl}}/users/terminate_sessions
BODY json
{
"user_ids": [],
"user_logins": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/terminate_sessions");
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 \"user_ids\": [],\n \"user_logins\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/terminate_sessions" {:content-type :json
:form-params {:user_ids []
:user_logins []}})
require "http/client"
url = "{{baseUrl}}/users/terminate_sessions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"user_ids\": [],\n \"user_logins\": []\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}}/users/terminate_sessions"),
Content = new StringContent("{\n \"user_ids\": [],\n \"user_logins\": []\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}}/users/terminate_sessions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"user_ids\": [],\n \"user_logins\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/terminate_sessions"
payload := strings.NewReader("{\n \"user_ids\": [],\n \"user_logins\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/users/terminate_sessions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 41
{
"user_ids": [],
"user_logins": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/terminate_sessions")
.setHeader("content-type", "application/json")
.setBody("{\n \"user_ids\": [],\n \"user_logins\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/terminate_sessions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"user_ids\": [],\n \"user_logins\": []\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 \"user_ids\": [],\n \"user_logins\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/terminate_sessions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/users/terminate_sessions")
.header("content-type", "application/json")
.body("{\n \"user_ids\": [],\n \"user_logins\": []\n}")
.asString();
const data = JSON.stringify({
user_ids: [],
user_logins: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/terminate_sessions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/terminate_sessions',
headers: {'content-type': 'application/json'},
data: {user_ids: [], user_logins: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/terminate_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"user_ids":[],"user_logins":[]}'
};
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}}/users/terminate_sessions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "user_ids": [],\n "user_logins": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"user_ids\": [],\n \"user_logins\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/terminate_sessions")
.post(body)
.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/users/terminate_sessions',
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({user_ids: [], user_logins: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/terminate_sessions',
headers: {'content-type': 'application/json'},
body: {user_ids: [], user_logins: []},
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}}/users/terminate_sessions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
user_ids: [],
user_logins: []
});
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}}/users/terminate_sessions',
headers: {'content-type': 'application/json'},
data: {user_ids: [], user_logins: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/terminate_sessions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"user_ids":[],"user_logins":[]}'
};
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 = @{ @"user_ids": @[ ],
@"user_logins": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/terminate_sessions"]
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}}/users/terminate_sessions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"user_ids\": [],\n \"user_logins\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/terminate_sessions",
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([
'user_ids' => [
],
'user_logins' => [
]
]),
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('POST', '{{baseUrl}}/users/terminate_sessions', [
'body' => '{
"user_ids": [],
"user_logins": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/terminate_sessions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'user_ids' => [
],
'user_logins' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'user_ids' => [
],
'user_logins' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/users/terminate_sessions');
$request->setRequestMethod('POST');
$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}}/users/terminate_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"user_ids": [],
"user_logins": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/terminate_sessions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"user_ids": [],
"user_logins": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"user_ids\": [],\n \"user_logins\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users/terminate_sessions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/terminate_sessions"
payload = {
"user_ids": [],
"user_logins": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/terminate_sessions"
payload <- "{\n \"user_ids\": [],\n \"user_logins\": []\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}}/users/terminate_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"user_ids\": [],\n \"user_logins\": []\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/users/terminate_sessions') do |req|
req.body = "{\n \"user_ids\": [],\n \"user_logins\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/terminate_sessions";
let payload = json!({
"user_ids": (),
"user_logins": ()
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/users/terminate_sessions \
--header 'content-type: application/json' \
--data '{
"user_ids": [],
"user_logins": []
}'
echo '{
"user_ids": [],
"user_logins": []
}' | \
http POST {{baseUrl}}/users/terminate_sessions \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "user_ids": [],\n "user_logins": []\n}' \
--output-document \
- {{baseUrl}}/users/terminate_sessions
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"user_ids": [],
"user_logins": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/terminate_sessions")! 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
{
"message": "Request is successful, please check the admin events for the status of the job"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create user
{{baseUrl}}/users
BODY json
{
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users");
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 \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users" {:content-type :json
:form-params {:address ""
:can_see_managed_users false
:external_app_user_id ""
:is_exempt_from_device_limits false
:is_exempt_from_login_verification false
:is_external_collab_restricted false
:is_platform_access_only false
:is_sync_enabled false
:job_title ""
:language ""
:login ""
:name ""
:phone ""
:role ""
:space_amount 0
:status ""
:timezone ""
:tracking_codes [{:name ""
:type ""
:value ""}]}})
require "http/client"
url = "{{baseUrl}}/users"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\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}}/users"),
Content = new StringContent("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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}}/users");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users"
payload := strings.NewReader("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/users HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 519
{
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users")
.setHeader("content-type", "application/json")
.setBody("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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 \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/users")
.header("content-type", "application/json")
.body("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}")
.asString();
const data = JSON.stringify({
address: '',
can_see_managed_users: false,
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_platform_access_only: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [
{
name: '',
type: '',
value: ''
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users',
headers: {'content-type': 'application/json'},
data: {
address: '',
can_see_managed_users: false,
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_platform_access_only: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address":"","can_see_managed_users":false,"external_app_user_id":"","is_exempt_from_device_limits":false,"is_exempt_from_login_verification":false,"is_external_collab_restricted":false,"is_platform_access_only":false,"is_sync_enabled":false,"job_title":"","language":"","login":"","name":"","phone":"","role":"","space_amount":0,"status":"","timezone":"","tracking_codes":[{"name":"","type":"","value":""}]}'
};
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}}/users',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address": "",\n "can_see_managed_users": false,\n "external_app_user_id": "",\n "is_exempt_from_device_limits": false,\n "is_exempt_from_login_verification": false,\n "is_external_collab_restricted": false,\n "is_platform_access_only": false,\n "is_sync_enabled": false,\n "job_title": "",\n "language": "",\n "login": "",\n "name": "",\n "phone": "",\n "role": "",\n "space_amount": 0,\n "status": "",\n "timezone": "",\n "tracking_codes": [\n {\n "name": "",\n "type": "",\n "value": ""\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 \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users")
.post(body)
.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/users',
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({
address: '',
can_see_managed_users: false,
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_platform_access_only: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users',
headers: {'content-type': 'application/json'},
body: {
address: '',
can_see_managed_users: false,
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_platform_access_only: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
},
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}}/users');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address: '',
can_see_managed_users: false,
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_platform_access_only: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [
{
name: '',
type: '',
value: ''
}
]
});
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}}/users',
headers: {'content-type': 'application/json'},
data: {
address: '',
can_see_managed_users: false,
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_platform_access_only: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address":"","can_see_managed_users":false,"external_app_user_id":"","is_exempt_from_device_limits":false,"is_exempt_from_login_verification":false,"is_external_collab_restricted":false,"is_platform_access_only":false,"is_sync_enabled":false,"job_title":"","language":"","login":"","name":"","phone":"","role":"","space_amount":0,"status":"","timezone":"","tracking_codes":[{"name":"","type":"","value":""}]}'
};
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 = @{ @"address": @"",
@"can_see_managed_users": @NO,
@"external_app_user_id": @"",
@"is_exempt_from_device_limits": @NO,
@"is_exempt_from_login_verification": @NO,
@"is_external_collab_restricted": @NO,
@"is_platform_access_only": @NO,
@"is_sync_enabled": @NO,
@"job_title": @"",
@"language": @"",
@"login": @"",
@"name": @"",
@"phone": @"",
@"role": @"",
@"space_amount": @0,
@"status": @"",
@"timezone": @"",
@"tracking_codes": @[ @{ @"name": @"", @"type": @"", @"value": @"" } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users"]
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}}/users" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users",
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([
'address' => '',
'can_see_managed_users' => null,
'external_app_user_id' => '',
'is_exempt_from_device_limits' => null,
'is_exempt_from_login_verification' => null,
'is_external_collab_restricted' => null,
'is_platform_access_only' => null,
'is_sync_enabled' => null,
'job_title' => '',
'language' => '',
'login' => '',
'name' => '',
'phone' => '',
'role' => '',
'space_amount' => 0,
'status' => '',
'timezone' => '',
'tracking_codes' => [
[
'name' => '',
'type' => '',
'value' => ''
]
]
]),
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('POST', '{{baseUrl}}/users', [
'body' => '{
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address' => '',
'can_see_managed_users' => null,
'external_app_user_id' => '',
'is_exempt_from_device_limits' => null,
'is_exempt_from_login_verification' => null,
'is_external_collab_restricted' => null,
'is_platform_access_only' => null,
'is_sync_enabled' => null,
'job_title' => '',
'language' => '',
'login' => '',
'name' => '',
'phone' => '',
'role' => '',
'space_amount' => 0,
'status' => '',
'timezone' => '',
'tracking_codes' => [
[
'name' => '',
'type' => '',
'value' => ''
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address' => '',
'can_see_managed_users' => null,
'external_app_user_id' => '',
'is_exempt_from_device_limits' => null,
'is_exempt_from_login_verification' => null,
'is_external_collab_restricted' => null,
'is_platform_access_only' => null,
'is_sync_enabled' => null,
'job_title' => '',
'language' => '',
'login' => '',
'name' => '',
'phone' => '',
'role' => '',
'space_amount' => 0,
'status' => '',
'timezone' => '',
'tracking_codes' => [
[
'name' => '',
'type' => '',
'value' => ''
]
]
]));
$request->setRequestUrl('{{baseUrl}}/users');
$request->setRequestMethod('POST');
$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}}/users' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users"
payload = {
"address": "",
"can_see_managed_users": False,
"external_app_user_id": "",
"is_exempt_from_device_limits": False,
"is_exempt_from_login_verification": False,
"is_external_collab_restricted": False,
"is_platform_access_only": False,
"is_sync_enabled": False,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users"
payload <- "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\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}}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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.post('/baseUrl/users') do |req|
req.body = "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_platform_access_only\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users";
let payload = json!({
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": (
json!({
"name": "",
"type": "",
"value": ""
})
)
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/users \
--header 'content-type: application/json' \
--data '{
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}'
echo '{
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}' | \
http POST {{baseUrl}}/users \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "address": "",\n "can_see_managed_users": false,\n "external_app_user_id": "",\n "is_exempt_from_device_limits": false,\n "is_exempt_from_login_verification": false,\n "is_external_collab_restricted": false,\n "is_platform_access_only": false,\n "is_sync_enabled": false,\n "job_title": "",\n "language": "",\n "login": "",\n "name": "",\n "phone": "",\n "role": "",\n "space_amount": 0,\n "status": "",\n "timezone": "",\n "tracking_codes": [\n {\n "name": "",\n "type": "",\n "value": ""\n }\n ]\n}' \
--output-document \
- {{baseUrl}}/users
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address": "",
"can_see_managed_users": false,
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_platform_access_only": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
[
"name": "",
"type": "",
"value": ""
]
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Delete user
{{baseUrl}}/users/:user_id
QUERY PARAMS
user_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/users/:user_id")
require "http/client"
url = "{{baseUrl}}/users/:user_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/users/:user_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/users/:user_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/users/:user_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id"))
.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}}/users/:user_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/users/:user_id")
.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}}/users/:user_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/users/:user_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id';
const options = {method: 'DELETE'};
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}}/users/:user_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id',
headers: {}
};
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}}/users/:user_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/users/:user_id');
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}}/users/:user_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/users/:user_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/users/:user_id');
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/:user_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/users/:user_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/users/:user_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/users/:user_id
http DELETE {{baseUrl}}/users/:user_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/users/:user_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get current user
{{baseUrl}}/users/me
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/me");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/me")
require "http/client"
url = "{{baseUrl}}/users/me"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/me"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/me");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/me"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/me HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/me")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/me"))
.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}}/users/me")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/me")
.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}}/users/me');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/me'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/me';
const options = {method: 'GET'};
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}}/users/me',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/me")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/me',
headers: {}
};
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}}/users/me'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/me');
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}}/users/me'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/me';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/me"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/me" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/users/me');
echo $response->getBody();
setUrl('{{baseUrl}}/users/me');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/me');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/me' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/me' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/me")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/me"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/me"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/me') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/me";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/me
http GET {{baseUrl}}/users/me
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/me
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/me")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get user
{{baseUrl}}/users/:user_id
QUERY PARAMS
user_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:user_id")
require "http/client"
url = "{{baseUrl}}/users/:user_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:user_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/:user_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/:user_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:user_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id"))
.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}}/users/:user_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/:user_id")
.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}}/users/:user_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:user_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id';
const options = {method: 'GET'};
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}}/users/:user_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:user_id',
headers: {}
};
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}}/users/:user_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:user_id');
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}}/users/:user_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/:user_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/users/:user_id');
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/:user_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:user_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:user_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:user_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:user_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:user_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:user_id
http GET {{baseUrl}}/users/:user_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:user_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List enterprise users
{{baseUrl}}/users
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users")
require "http/client"
url = "{{baseUrl}}/users"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users"))
.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}}/users")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users")
.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}}/users');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users';
const options = {method: 'GET'};
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}}/users',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users',
headers: {}
};
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}}/users'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users');
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}}/users'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/users');
echo $response->getBody();
setUrl('{{baseUrl}}/users');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users
http GET {{baseUrl}}/users
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update user
{{baseUrl}}/users/:user_id
QUERY PARAMS
user_id
BODY json
{
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": {
"email": ""
},
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:user_id");
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 \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/users/:user_id" {:content-type :json
:form-params {:address ""
:can_see_managed_users false
:enterprise ""
:external_app_user_id ""
:is_exempt_from_device_limits false
:is_exempt_from_login_verification false
:is_external_collab_restricted false
:is_password_reset_required false
:is_sync_enabled false
:job_title ""
:language ""
:login ""
:name ""
:notification_email {:email ""}
:notify false
:phone ""
:role ""
:space_amount 0
:status ""
:timezone ""
:tracking_codes [{:name ""
:type ""
:value ""}]}})
require "http/client"
url = "{{baseUrl}}/users/:user_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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}}/users/:user_id"),
Content = new StringContent("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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}}/users/:user_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:user_id"
payload := strings.NewReader("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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/users/:user_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 608
{
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": {
"email": ""
},
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/users/:user_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:user_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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 \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:user_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/users/:user_id")
.header("content-type", "application/json")
.body("{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}")
.asString();
const data = JSON.stringify({
address: '',
can_see_managed_users: false,
enterprise: '',
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_password_reset_required: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
notification_email: {
email: ''
},
notify: false,
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [
{
name: '',
type: '',
value: ''
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/users/:user_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/users/:user_id',
headers: {'content-type': 'application/json'},
data: {
address: '',
can_see_managed_users: false,
enterprise: '',
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_password_reset_required: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
notification_email: {email: ''},
notify: false,
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/:user_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"address":"","can_see_managed_users":false,"enterprise":"","external_app_user_id":"","is_exempt_from_device_limits":false,"is_exempt_from_login_verification":false,"is_external_collab_restricted":false,"is_password_reset_required":false,"is_sync_enabled":false,"job_title":"","language":"","login":"","name":"","notification_email":{"email":""},"notify":false,"phone":"","role":"","space_amount":0,"status":"","timezone":"","tracking_codes":[{"name":"","type":"","value":""}]}'
};
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}}/users/:user_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address": "",\n "can_see_managed_users": false,\n "enterprise": "",\n "external_app_user_id": "",\n "is_exempt_from_device_limits": false,\n "is_exempt_from_login_verification": false,\n "is_external_collab_restricted": false,\n "is_password_reset_required": false,\n "is_sync_enabled": false,\n "job_title": "",\n "language": "",\n "login": "",\n "name": "",\n "notification_email": {\n "email": ""\n },\n "notify": false,\n "phone": "",\n "role": "",\n "space_amount": 0,\n "status": "",\n "timezone": "",\n "tracking_codes": [\n {\n "name": "",\n "type": "",\n "value": ""\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 \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/:user_id")
.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/users/:user_id',
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({
address: '',
can_see_managed_users: false,
enterprise: '',
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_password_reset_required: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
notification_email: {email: ''},
notify: false,
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/users/:user_id',
headers: {'content-type': 'application/json'},
body: {
address: '',
can_see_managed_users: false,
enterprise: '',
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_password_reset_required: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
notification_email: {email: ''},
notify: false,
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
},
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}}/users/:user_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address: '',
can_see_managed_users: false,
enterprise: '',
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_password_reset_required: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
notification_email: {
email: ''
},
notify: false,
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [
{
name: '',
type: '',
value: ''
}
]
});
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}}/users/:user_id',
headers: {'content-type': 'application/json'},
data: {
address: '',
can_see_managed_users: false,
enterprise: '',
external_app_user_id: '',
is_exempt_from_device_limits: false,
is_exempt_from_login_verification: false,
is_external_collab_restricted: false,
is_password_reset_required: false,
is_sync_enabled: false,
job_title: '',
language: '',
login: '',
name: '',
notification_email: {email: ''},
notify: false,
phone: '',
role: '',
space_amount: 0,
status: '',
timezone: '',
tracking_codes: [{name: '', type: '', value: ''}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:user_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"address":"","can_see_managed_users":false,"enterprise":"","external_app_user_id":"","is_exempt_from_device_limits":false,"is_exempt_from_login_verification":false,"is_external_collab_restricted":false,"is_password_reset_required":false,"is_sync_enabled":false,"job_title":"","language":"","login":"","name":"","notification_email":{"email":""},"notify":false,"phone":"","role":"","space_amount":0,"status":"","timezone":"","tracking_codes":[{"name":"","type":"","value":""}]}'
};
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 = @{ @"address": @"",
@"can_see_managed_users": @NO,
@"enterprise": @"",
@"external_app_user_id": @"",
@"is_exempt_from_device_limits": @NO,
@"is_exempt_from_login_verification": @NO,
@"is_external_collab_restricted": @NO,
@"is_password_reset_required": @NO,
@"is_sync_enabled": @NO,
@"job_title": @"",
@"language": @"",
@"login": @"",
@"name": @"",
@"notification_email": @{ @"email": @"" },
@"notify": @NO,
@"phone": @"",
@"role": @"",
@"space_amount": @0,
@"status": @"",
@"timezone": @"",
@"tracking_codes": @[ @{ @"name": @"", @"type": @"", @"value": @"" } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:user_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}}/users/:user_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/:user_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([
'address' => '',
'can_see_managed_users' => null,
'enterprise' => '',
'external_app_user_id' => '',
'is_exempt_from_device_limits' => null,
'is_exempt_from_login_verification' => null,
'is_external_collab_restricted' => null,
'is_password_reset_required' => null,
'is_sync_enabled' => null,
'job_title' => '',
'language' => '',
'login' => '',
'name' => '',
'notification_email' => [
'email' => ''
],
'notify' => null,
'phone' => '',
'role' => '',
'space_amount' => 0,
'status' => '',
'timezone' => '',
'tracking_codes' => [
[
'name' => '',
'type' => '',
'value' => ''
]
]
]),
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}}/users/:user_id', [
'body' => '{
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": {
"email": ""
},
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/:user_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address' => '',
'can_see_managed_users' => null,
'enterprise' => '',
'external_app_user_id' => '',
'is_exempt_from_device_limits' => null,
'is_exempt_from_login_verification' => null,
'is_external_collab_restricted' => null,
'is_password_reset_required' => null,
'is_sync_enabled' => null,
'job_title' => '',
'language' => '',
'login' => '',
'name' => '',
'notification_email' => [
'email' => ''
],
'notify' => null,
'phone' => '',
'role' => '',
'space_amount' => 0,
'status' => '',
'timezone' => '',
'tracking_codes' => [
[
'name' => '',
'type' => '',
'value' => ''
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address' => '',
'can_see_managed_users' => null,
'enterprise' => '',
'external_app_user_id' => '',
'is_exempt_from_device_limits' => null,
'is_exempt_from_login_verification' => null,
'is_external_collab_restricted' => null,
'is_password_reset_required' => null,
'is_sync_enabled' => null,
'job_title' => '',
'language' => '',
'login' => '',
'name' => '',
'notification_email' => [
'email' => ''
],
'notify' => null,
'phone' => '',
'role' => '',
'space_amount' => 0,
'status' => '',
'timezone' => '',
'tracking_codes' => [
[
'name' => '',
'type' => '',
'value' => ''
]
]
]));
$request->setRequestUrl('{{baseUrl}}/users/:user_id');
$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}}/users/:user_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": {
"email": ""
},
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:user_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": {
"email": ""
},
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/users/:user_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/:user_id"
payload = {
"address": "",
"can_see_managed_users": False,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": False,
"is_exempt_from_login_verification": False,
"is_external_collab_restricted": False,
"is_password_reset_required": False,
"is_sync_enabled": False,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": { "email": "" },
"notify": False,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/:user_id"
payload <- "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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}}/users/:user_id")
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 \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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/users/:user_id') do |req|
req.body = "{\n \"address\": \"\",\n \"can_see_managed_users\": false,\n \"enterprise\": \"\",\n \"external_app_user_id\": \"\",\n \"is_exempt_from_device_limits\": false,\n \"is_exempt_from_login_verification\": false,\n \"is_external_collab_restricted\": false,\n \"is_password_reset_required\": false,\n \"is_sync_enabled\": false,\n \"job_title\": \"\",\n \"language\": \"\",\n \"login\": \"\",\n \"name\": \"\",\n \"notification_email\": {\n \"email\": \"\"\n },\n \"notify\": false,\n \"phone\": \"\",\n \"role\": \"\",\n \"space_amount\": 0,\n \"status\": \"\",\n \"timezone\": \"\",\n \"tracking_codes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\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}}/users/:user_id";
let payload = json!({
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": json!({"email": ""}),
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": (
json!({
"name": "",
"type": "",
"value": ""
})
)
});
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}}/users/:user_id \
--header 'content-type: application/json' \
--data '{
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": {
"email": ""
},
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}'
echo '{
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": {
"email": ""
},
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
{
"name": "",
"type": "",
"value": ""
}
]
}' | \
http PUT {{baseUrl}}/users/:user_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "address": "",\n "can_see_managed_users": false,\n "enterprise": "",\n "external_app_user_id": "",\n "is_exempt_from_device_limits": false,\n "is_exempt_from_login_verification": false,\n "is_external_collab_restricted": false,\n "is_password_reset_required": false,\n "is_sync_enabled": false,\n "job_title": "",\n "language": "",\n "login": "",\n "name": "",\n "notification_email": {\n "email": ""\n },\n "notify": false,\n "phone": "",\n "role": "",\n "space_amount": 0,\n "status": "",\n "timezone": "",\n "tracking_codes": [\n {\n "name": "",\n "type": "",\n "value": ""\n }\n ]\n}' \
--output-document \
- {{baseUrl}}/users/:user_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address": "",
"can_see_managed_users": false,
"enterprise": "",
"external_app_user_id": "",
"is_exempt_from_device_limits": false,
"is_exempt_from_login_verification": false,
"is_external_collab_restricted": false,
"is_password_reset_required": false,
"is_sync_enabled": false,
"job_title": "",
"language": "",
"login": "",
"name": "",
"notification_email": ["email": ""],
"notify": false,
"phone": "",
"role": "",
"space_amount": 0,
"status": "",
"timezone": "",
"tracking_codes": [
[
"name": "",
"type": "",
"value": ""
]
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:user_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Apply watermark to file
{{baseUrl}}/files/:file_id/watermark
QUERY PARAMS
file_id
BODY json
{
"watermark": {
"imprint": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/watermark");
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 \"watermark\": {\n \"imprint\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/files/:file_id/watermark" {:content-type :json
:form-params {:watermark {:imprint ""}}})
require "http/client"
url = "{{baseUrl}}/files/:file_id/watermark"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"watermark\": {\n \"imprint\": \"\"\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}}/files/:file_id/watermark"),
Content = new StringContent("{\n \"watermark\": {\n \"imprint\": \"\"\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}}/files/:file_id/watermark");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/watermark"
payload := strings.NewReader("{\n \"watermark\": {\n \"imprint\": \"\"\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/files/:file_id/watermark HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 42
{
"watermark": {
"imprint": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/files/:file_id/watermark")
.setHeader("content-type", "application/json")
.setBody("{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/watermark"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"watermark\": {\n \"imprint\": \"\"\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 \"watermark\": {\n \"imprint\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/files/:file_id/watermark")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/files/:file_id/watermark")
.header("content-type", "application/json")
.body("{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
watermark: {
imprint: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/files/:file_id/watermark');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id/watermark',
headers: {'content-type': 'application/json'},
data: {watermark: {imprint: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/watermark';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"watermark":{"imprint":""}}'
};
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}}/files/:file_id/watermark',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "watermark": {\n "imprint": ""\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 \"watermark\": {\n \"imprint\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/watermark")
.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/files/:file_id/watermark',
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({watermark: {imprint: ''}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/files/:file_id/watermark',
headers: {'content-type': 'application/json'},
body: {watermark: {imprint: ''}},
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}}/files/:file_id/watermark');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
watermark: {
imprint: ''
}
});
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}}/files/:file_id/watermark',
headers: {'content-type': 'application/json'},
data: {watermark: {imprint: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/watermark';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"watermark":{"imprint":""}}'
};
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 = @{ @"watermark": @{ @"imprint": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/watermark"]
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}}/files/:file_id/watermark" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/watermark",
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([
'watermark' => [
'imprint' => ''
]
]),
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}}/files/:file_id/watermark', [
'body' => '{
"watermark": {
"imprint": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/watermark');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'watermark' => [
'imprint' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'watermark' => [
'imprint' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/files/:file_id/watermark');
$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}}/files/:file_id/watermark' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"watermark": {
"imprint": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/watermark' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"watermark": {
"imprint": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/files/:file_id/watermark", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/watermark"
payload = { "watermark": { "imprint": "" } }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/watermark"
payload <- "{\n \"watermark\": {\n \"imprint\": \"\"\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}}/files/:file_id/watermark")
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 \"watermark\": {\n \"imprint\": \"\"\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/files/:file_id/watermark') do |req|
req.body = "{\n \"watermark\": {\n \"imprint\": \"\"\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}}/files/:file_id/watermark";
let payload = json!({"watermark": json!({"imprint": ""})});
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}}/files/:file_id/watermark \
--header 'content-type: application/json' \
--data '{
"watermark": {
"imprint": ""
}
}'
echo '{
"watermark": {
"imprint": ""
}
}' | \
http PUT {{baseUrl}}/files/:file_id/watermark \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "watermark": {\n "imprint": ""\n }\n}' \
--output-document \
- {{baseUrl}}/files/:file_id/watermark
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["watermark": ["imprint": ""]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/watermark")! 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
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get watermark on file
{{baseUrl}}/files/:file_id/watermark
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/watermark");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/files/:file_id/watermark")
require "http/client"
url = "{{baseUrl}}/files/:file_id/watermark"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/watermark"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/watermark");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/watermark"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/files/:file_id/watermark HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/files/:file_id/watermark")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/watermark"))
.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}}/files/:file_id/watermark")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/files/:file_id/watermark")
.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}}/files/:file_id/watermark');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/files/:file_id/watermark'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/watermark';
const options = {method: 'GET'};
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}}/files/:file_id/watermark',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/watermark")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/watermark',
headers: {}
};
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}}/files/:file_id/watermark'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/files/:file_id/watermark');
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}}/files/:file_id/watermark'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/watermark';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/watermark"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/files/:file_id/watermark" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/watermark",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/files/:file_id/watermark');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/watermark');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/watermark');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/watermark' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/watermark' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/files/:file_id/watermark")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/watermark"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/watermark"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/watermark")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/files/:file_id/watermark') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/watermark";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/files/:file_id/watermark
http GET {{baseUrl}}/files/:file_id/watermark
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/files/:file_id/watermark
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/watermark")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove watermark from file
{{baseUrl}}/files/:file_id/watermark
QUERY PARAMS
file_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/files/:file_id/watermark");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/files/:file_id/watermark")
require "http/client"
url = "{{baseUrl}}/files/:file_id/watermark"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/files/:file_id/watermark"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/files/:file_id/watermark");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/files/:file_id/watermark"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/files/:file_id/watermark HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/files/:file_id/watermark")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/files/:file_id/watermark"))
.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}}/files/:file_id/watermark")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/files/:file_id/watermark")
.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}}/files/:file_id/watermark');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/files/:file_id/watermark'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/files/:file_id/watermark';
const options = {method: 'DELETE'};
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}}/files/:file_id/watermark',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/files/:file_id/watermark")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/files/:file_id/watermark',
headers: {}
};
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}}/files/:file_id/watermark'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/files/:file_id/watermark');
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}}/files/:file_id/watermark'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/files/:file_id/watermark';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/files/:file_id/watermark"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/files/:file_id/watermark" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/files/:file_id/watermark",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/files/:file_id/watermark');
echo $response->getBody();
setUrl('{{baseUrl}}/files/:file_id/watermark');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/files/:file_id/watermark');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/files/:file_id/watermark' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/files/:file_id/watermark' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/files/:file_id/watermark")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/files/:file_id/watermark"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/files/:file_id/watermark"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/files/:file_id/watermark")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/files/:file_id/watermark') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/files/:file_id/watermark";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/files/:file_id/watermark
http DELETE {{baseUrl}}/files/:file_id/watermark
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/files/:file_id/watermark
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/files/:file_id/watermark")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Apply watermark to folder
{{baseUrl}}/folders/:folder_id/watermark
QUERY PARAMS
folder_id
BODY json
{
"watermark": {
"imprint": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/watermark");
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 \"watermark\": {\n \"imprint\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/folders/:folder_id/watermark" {:content-type :json
:form-params {:watermark {:imprint ""}}})
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/watermark"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"watermark\": {\n \"imprint\": \"\"\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}}/folders/:folder_id/watermark"),
Content = new StringContent("{\n \"watermark\": {\n \"imprint\": \"\"\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}}/folders/:folder_id/watermark");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/watermark"
payload := strings.NewReader("{\n \"watermark\": {\n \"imprint\": \"\"\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/folders/:folder_id/watermark HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 42
{
"watermark": {
"imprint": ""
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/folders/:folder_id/watermark")
.setHeader("content-type", "application/json")
.setBody("{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/watermark"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"watermark\": {\n \"imprint\": \"\"\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 \"watermark\": {\n \"imprint\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/watermark")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/folders/:folder_id/watermark")
.header("content-type", "application/json")
.body("{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}")
.asString();
const data = JSON.stringify({
watermark: {
imprint: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/folders/:folder_id/watermark');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id/watermark',
headers: {'content-type': 'application/json'},
data: {watermark: {imprint: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/watermark';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"watermark":{"imprint":""}}'
};
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}}/folders/:folder_id/watermark',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "watermark": {\n "imprint": ""\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 \"watermark\": {\n \"imprint\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/watermark")
.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/folders/:folder_id/watermark',
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({watermark: {imprint: ''}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/folders/:folder_id/watermark',
headers: {'content-type': 'application/json'},
body: {watermark: {imprint: ''}},
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}}/folders/:folder_id/watermark');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
watermark: {
imprint: ''
}
});
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}}/folders/:folder_id/watermark',
headers: {'content-type': 'application/json'},
data: {watermark: {imprint: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/watermark';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"watermark":{"imprint":""}}'
};
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 = @{ @"watermark": @{ @"imprint": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/watermark"]
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}}/folders/:folder_id/watermark" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/watermark",
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([
'watermark' => [
'imprint' => ''
]
]),
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}}/folders/:folder_id/watermark', [
'body' => '{
"watermark": {
"imprint": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/watermark');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'watermark' => [
'imprint' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'watermark' => [
'imprint' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id/watermark');
$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}}/folders/:folder_id/watermark' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"watermark": {
"imprint": ""
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/watermark' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"watermark": {
"imprint": ""
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"watermark\": {\n \"imprint\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/folders/:folder_id/watermark", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/watermark"
payload = { "watermark": { "imprint": "" } }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/watermark"
payload <- "{\n \"watermark\": {\n \"imprint\": \"\"\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}}/folders/:folder_id/watermark")
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 \"watermark\": {\n \"imprint\": \"\"\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/folders/:folder_id/watermark') do |req|
req.body = "{\n \"watermark\": {\n \"imprint\": \"\"\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}}/folders/:folder_id/watermark";
let payload = json!({"watermark": json!({"imprint": ""})});
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}}/folders/:folder_id/watermark \
--header 'content-type: application/json' \
--data '{
"watermark": {
"imprint": ""
}
}'
echo '{
"watermark": {
"imprint": ""
}
}' | \
http PUT {{baseUrl}}/folders/:folder_id/watermark \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "watermark": {\n "imprint": ""\n }\n}' \
--output-document \
- {{baseUrl}}/folders/:folder_id/watermark
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["watermark": ["imprint": ""]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/watermark")! 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
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get watermark for folder
{{baseUrl}}/folders/:folder_id/watermark
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/watermark");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/:folder_id/watermark")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/watermark"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/watermark"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/watermark");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/watermark"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/folders/:folder_id/watermark HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/:folder_id/watermark")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/watermark"))
.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}}/folders/:folder_id/watermark")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/folders/:folder_id/watermark")
.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}}/folders/:folder_id/watermark');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/folders/:folder_id/watermark'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/watermark';
const options = {method: 'GET'};
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}}/folders/:folder_id/watermark',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/watermark")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/watermark',
headers: {}
};
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}}/folders/:folder_id/watermark'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/:folder_id/watermark');
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}}/folders/:folder_id/watermark'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/watermark';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/watermark"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/folders/:folder_id/watermark" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/watermark",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/folders/:folder_id/watermark');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/watermark');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/watermark');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/watermark' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/watermark' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/:folder_id/watermark")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/watermark"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/watermark"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/watermark")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/:folder_id/watermark') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/watermark";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/:folder_id/watermark
http GET {{baseUrl}}/folders/:folder_id/watermark
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/:folder_id/watermark
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/watermark")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove watermark from folder
{{baseUrl}}/folders/:folder_id/watermark
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/watermark");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/folders/:folder_id/watermark")
require "http/client"
url = "{{baseUrl}}/folders/:folder_id/watermark"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/watermark"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/folders/:folder_id/watermark");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/watermark"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/folders/:folder_id/watermark HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/folders/:folder_id/watermark")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/watermark"))
.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}}/folders/:folder_id/watermark")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/folders/:folder_id/watermark")
.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}}/folders/:folder_id/watermark');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/folders/:folder_id/watermark'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/folders/:folder_id/watermark';
const options = {method: 'DELETE'};
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}}/folders/:folder_id/watermark',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/watermark")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/watermark',
headers: {}
};
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}}/folders/:folder_id/watermark'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/folders/:folder_id/watermark');
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}}/folders/:folder_id/watermark'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/watermark';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/watermark"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/folders/:folder_id/watermark" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/folders/:folder_id/watermark",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/folders/:folder_id/watermark');
echo $response->getBody();
setUrl('{{baseUrl}}/folders/:folder_id/watermark');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/folders/:folder_id/watermark');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/watermark' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/watermark' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/folders/:folder_id/watermark")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/folders/:folder_id/watermark"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/folders/:folder_id/watermark"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/watermark")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/folders/:folder_id/watermark') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/watermark";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/folders/:folder_id/watermark
http DELETE {{baseUrl}}/folders/:folder_id/watermark
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/folders/:folder_id/watermark
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/watermark")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create web link
{{baseUrl}}/web_links
BODY json
{
"description": "",
"name": "",
"parent": {
"id": ""
},
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links");
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 \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/web_links" {:content-type :json
:form-params {:description ""
:name ""
:parent {:id ""}
:shared_link {:access ""
:password ""
:unshared_at ""
:vanity_name ""}
:url ""}})
require "http/client"
url = "{{baseUrl}}/web_links"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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}}/web_links"),
Content = new StringContent("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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}}/web_links");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links"
payload := strings.NewReader("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/web_links HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 189
{
"description": "",
"name": "",
"parent": {
"id": ""
},
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/web_links")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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 \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/web_links")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/web_links")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
name: '',
parent: {
id: ''
},
shared_link: {
access: '',
password: '',
unshared_at: '',
vanity_name: ''
},
url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/web_links');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/web_links',
headers: {'content-type': 'application/json'},
data: {
description: '',
name: '',
parent: {id: ''},
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","parent":{"id":""},"shared_link":{"access":"","password":"","unshared_at":"","vanity_name":""},"url":""}'
};
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}}/web_links',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "name": "",\n "parent": {\n "id": ""\n },\n "shared_link": {\n "access": "",\n "password": "",\n "unshared_at": "",\n "vanity_name": ""\n },\n "url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/web_links")
.post(body)
.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/web_links',
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({
description: '',
name: '',
parent: {id: ''},
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/web_links',
headers: {'content-type': 'application/json'},
body: {
description: '',
name: '',
parent: {id: ''},
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
},
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}}/web_links');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
name: '',
parent: {
id: ''
},
shared_link: {
access: '',
password: '',
unshared_at: '',
vanity_name: ''
},
url: ''
});
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}}/web_links',
headers: {'content-type': 'application/json'},
data: {
description: '',
name: '',
parent: {id: ''},
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","parent":{"id":""},"shared_link":{"access":"","password":"","unshared_at":"","vanity_name":""},"url":""}'
};
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 = @{ @"description": @"",
@"name": @"",
@"parent": @{ @"id": @"" },
@"shared_link": @{ @"access": @"", @"password": @"", @"unshared_at": @"", @"vanity_name": @"" },
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links"]
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}}/web_links" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links",
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([
'description' => '',
'name' => '',
'parent' => [
'id' => ''
],
'shared_link' => [
'access' => '',
'password' => '',
'unshared_at' => '',
'vanity_name' => ''
],
'url' => ''
]),
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('POST', '{{baseUrl}}/web_links', [
'body' => '{
"description": "",
"name": "",
"parent": {
"id": ""
},
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/web_links');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'name' => '',
'parent' => [
'id' => ''
],
'shared_link' => [
'access' => '',
'password' => '',
'unshared_at' => '',
'vanity_name' => ''
],
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'name' => '',
'parent' => [
'id' => ''
],
'shared_link' => [
'access' => '',
'password' => '',
'unshared_at' => '',
'vanity_name' => ''
],
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/web_links');
$request->setRequestMethod('POST');
$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}}/web_links' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"parent": {
"id": ""
},
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"parent": {
"id": ""
},
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/web_links", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links"
payload = {
"description": "",
"name": "",
"parent": { "id": "" },
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links"
payload <- "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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}}/web_links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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/web_links') do |req|
req.body = "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/web_links";
let payload = json!({
"description": "",
"name": "",
"parent": json!({"id": ""}),
"shared_link": json!({
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
}),
"url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/web_links \
--header 'content-type: application/json' \
--data '{
"description": "",
"name": "",
"parent": {
"id": ""
},
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}'
echo '{
"description": "",
"name": "",
"parent": {
"id": ""
},
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}' | \
http POST {{baseUrl}}/web_links \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "name": "",\n "parent": {\n "id": ""\n },\n "shared_link": {\n "access": "",\n "password": "",\n "unshared_at": "",\n "vanity_name": ""\n },\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/web_links
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"name": "",
"parent": ["id": ""],
"shared_link": [
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
],
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get web link
{{baseUrl}}/web_links/:web_link_id
QUERY PARAMS
web_link_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/web_links/:web_link_id")
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/web_links/:web_link_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/web_links/:web_link_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/web_links/:web_link_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/web_links/:web_link_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id"))
.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}}/web_links/:web_link_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/web_links/:web_link_id")
.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}}/web_links/:web_link_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/web_links/:web_link_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {method: 'GET'};
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}}/web_links/:web_link_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/web_links/:web_link_id',
headers: {}
};
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}}/web_links/:web_link_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/web_links/:web_link_id');
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}}/web_links/:web_link_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/web_links/:web_link_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/web_links/:web_link_id');
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/web_links/:web_link_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/web_links/:web_link_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/web_links/:web_link_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/web_links/:web_link_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/web_links/:web_link_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/web_links/:web_link_id
http GET {{baseUrl}}/web_links/:web_link_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/web_links/:web_link_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove web link
{{baseUrl}}/web_links/:web_link_id
QUERY PARAMS
web_link_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/web_links/:web_link_id")
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/web_links/:web_link_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/web_links/:web_link_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/web_links/:web_link_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/web_links/:web_link_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id"))
.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}}/web_links/:web_link_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/web_links/:web_link_id")
.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}}/web_links/:web_link_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/web_links/:web_link_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {method: 'DELETE'};
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}}/web_links/:web_link_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/web_links/:web_link_id',
headers: {}
};
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}}/web_links/:web_link_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/web_links/:web_link_id');
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}}/web_links/:web_link_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/web_links/:web_link_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/web_links/:web_link_id');
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/web_links/:web_link_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/web_links/:web_link_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/web_links/:web_link_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/web_links/:web_link_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/web_links/:web_link_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/web_links/:web_link_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/web_links/:web_link_id
http DELETE {{baseUrl}}/web_links/:web_link_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/web_links/:web_link_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update web link
{{baseUrl}}/web_links/:web_link_id
QUERY PARAMS
web_link_id
BODY json
{
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/web_links/:web_link_id");
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 \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/web_links/:web_link_id" {:content-type :json
:form-params {:description ""
:name ""
:parent ""
:shared_link {:access ""
:password ""
:unshared_at ""
:vanity_name ""}
:url ""}})
require "http/client"
url = "{{baseUrl}}/web_links/:web_link_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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}}/web_links/:web_link_id"),
Content = new StringContent("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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}}/web_links/:web_link_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/web_links/:web_link_id"
payload := strings.NewReader("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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/web_links/:web_link_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 173
{
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/web_links/:web_link_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/web_links/:web_link_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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 \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/web_links/:web_link_id")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
name: '',
parent: '',
shared_link: {
access: '',
password: '',
unshared_at: '',
vanity_name: ''
},
url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/web_links/:web_link_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
name: '',
parent: '',
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","parent":"","shared_link":{"access":"","password":"","unshared_at":"","vanity_name":""},"url":""}'
};
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}}/web_links/:web_link_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "name": "",\n "parent": "",\n "shared_link": {\n "access": "",\n "password": "",\n "unshared_at": "",\n "vanity_name": ""\n },\n "url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/web_links/:web_link_id")
.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/web_links/:web_link_id',
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({
description: '',
name: '',
parent: '',
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/web_links/:web_link_id',
headers: {'content-type': 'application/json'},
body: {
description: '',
name: '',
parent: '',
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
},
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}}/web_links/:web_link_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
name: '',
parent: '',
shared_link: {
access: '',
password: '',
unshared_at: '',
vanity_name: ''
},
url: ''
});
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}}/web_links/:web_link_id',
headers: {'content-type': 'application/json'},
data: {
description: '',
name: '',
parent: '',
shared_link: {access: '', password: '', unshared_at: '', vanity_name: ''},
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/web_links/:web_link_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","parent":"","shared_link":{"access":"","password":"","unshared_at":"","vanity_name":""},"url":""}'
};
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 = @{ @"description": @"",
@"name": @"",
@"parent": @"",
@"shared_link": @{ @"access": @"", @"password": @"", @"unshared_at": @"", @"vanity_name": @"" },
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/web_links/:web_link_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}}/web_links/:web_link_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/web_links/:web_link_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([
'description' => '',
'name' => '',
'parent' => '',
'shared_link' => [
'access' => '',
'password' => '',
'unshared_at' => '',
'vanity_name' => ''
],
'url' => ''
]),
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}}/web_links/:web_link_id', [
'body' => '{
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/web_links/:web_link_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'name' => '',
'parent' => '',
'shared_link' => [
'access' => '',
'password' => '',
'unshared_at' => '',
'vanity_name' => ''
],
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'name' => '',
'parent' => '',
'shared_link' => [
'access' => '',
'password' => '',
'unshared_at' => '',
'vanity_name' => ''
],
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/web_links/:web_link_id');
$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}}/web_links/:web_link_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/web_links/:web_link_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/web_links/:web_link_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/web_links/:web_link_id"
payload = {
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/web_links/:web_link_id"
payload <- "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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}}/web_links/:web_link_id")
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 \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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/web_links/:web_link_id') do |req|
req.body = "{\n \"description\": \"\",\n \"name\": \"\",\n \"parent\": \"\",\n \"shared_link\": {\n \"access\": \"\",\n \"password\": \"\",\n \"unshared_at\": \"\",\n \"vanity_name\": \"\"\n },\n \"url\": \"\"\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}}/web_links/:web_link_id";
let payload = json!({
"description": "",
"name": "",
"parent": "",
"shared_link": json!({
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
}),
"url": ""
});
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}}/web_links/:web_link_id \
--header 'content-type: application/json' \
--data '{
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}'
echo '{
"description": "",
"name": "",
"parent": "",
"shared_link": {
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
},
"url": ""
}' | \
http PUT {{baseUrl}}/web_links/:web_link_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "name": "",\n "parent": "",\n "shared_link": {\n "access": "",\n "password": "",\n "unshared_at": "",\n "vanity_name": ""\n },\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/web_links/:web_link_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"name": "",
"parent": "",
"shared_link": [
"access": "",
"password": "",
"unshared_at": "",
"vanity_name": ""
],
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/web_links/:web_link_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create webhook
{{baseUrl}}/webhooks
BODY json
{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks");
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 \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/webhooks" {:content-type :json
:form-params {:address ""
:target {:id ""
:type ""}
:triggers []}})
require "http/client"
url = "{{baseUrl}}/webhooks"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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}}/webhooks"),
Content = new StringContent("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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}}/webhooks");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks"
payload := strings.NewReader("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/webhooks HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 85
{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/webhooks")
.setHeader("content-type", "application/json")
.setBody("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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 \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/webhooks")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/webhooks")
.header("content-type", "application/json")
.body("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}")
.asString();
const data = JSON.stringify({
address: '',
target: {
id: '',
type: ''
},
triggers: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/webhooks');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/webhooks',
headers: {'content-type': 'application/json'},
data: {address: '', target: {id: '', type: ''}, triggers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/webhooks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address":"","target":{"id":"","type":""},"triggers":[]}'
};
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}}/webhooks',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address": "",\n "target": {\n "id": "",\n "type": ""\n },\n "triggers": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/webhooks")
.post(body)
.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/webhooks',
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({address: '', target: {id: '', type: ''}, triggers: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/webhooks',
headers: {'content-type': 'application/json'},
body: {address: '', target: {id: '', type: ''}, triggers: []},
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}}/webhooks');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address: '',
target: {
id: '',
type: ''
},
triggers: []
});
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}}/webhooks',
headers: {'content-type': 'application/json'},
data: {address: '', target: {id: '', type: ''}, triggers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address":"","target":{"id":"","type":""},"triggers":[]}'
};
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 = @{ @"address": @"",
@"target": @{ @"id": @"", @"type": @"" },
@"triggers": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhooks"]
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}}/webhooks" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/webhooks",
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([
'address' => '',
'target' => [
'id' => '',
'type' => ''
],
'triggers' => [
]
]),
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('POST', '{{baseUrl}}/webhooks', [
'body' => '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/webhooks');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address' => '',
'target' => [
'id' => '',
'type' => ''
],
'triggers' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address' => '',
'target' => [
'id' => '',
'type' => ''
],
'triggers' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/webhooks');
$request->setRequestMethod('POST');
$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}}/webhooks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/webhooks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/webhooks"
payload = {
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/webhooks"
payload <- "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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}}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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/webhooks') do |req|
req.body = "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks";
let payload = json!({
"address": "",
"target": json!({
"id": "",
"type": ""
}),
"triggers": ()
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/webhooks \
--header 'content-type: application/json' \
--data '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}'
echo '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}' | \
http POST {{baseUrl}}/webhooks \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "address": "",\n "target": {\n "id": "",\n "type": ""\n },\n "triggers": []\n}' \
--output-document \
- {{baseUrl}}/webhooks
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address": "",
"target": [
"id": "",
"type": ""
],
"triggers": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Get webhook
{{baseUrl}}/webhooks/:webhook_id
QUERY PARAMS
webhook_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks/:webhook_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/webhooks/:webhook_id")
require "http/client"
url = "{{baseUrl}}/webhooks/:webhook_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/webhooks/:webhook_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/webhooks/:webhook_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks/:webhook_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/webhooks/:webhook_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/webhooks/:webhook_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks/:webhook_id"))
.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}}/webhooks/:webhook_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/webhooks/:webhook_id")
.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}}/webhooks/:webhook_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/webhooks/:webhook_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/webhooks/:webhook_id';
const options = {method: 'GET'};
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}}/webhooks/:webhook_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhooks/:webhook_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/webhooks/:webhook_id',
headers: {}
};
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}}/webhooks/:webhook_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/webhooks/:webhook_id');
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}}/webhooks/:webhook_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks/:webhook_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhooks/:webhook_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/webhooks/:webhook_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/webhooks/:webhook_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/webhooks/:webhook_id');
echo $response->getBody();
setUrl('{{baseUrl}}/webhooks/:webhook_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/webhooks/:webhook_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhooks/:webhook_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks/:webhook_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/webhooks/:webhook_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/webhooks/:webhook_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/webhooks/:webhook_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhooks/:webhook_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/webhooks/:webhook_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks/:webhook_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/webhooks/:webhook_id
http GET {{baseUrl}}/webhooks/:webhook_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/webhooks/:webhook_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks/:webhook_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List all webhooks
{{baseUrl}}/webhooks
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/webhooks")
require "http/client"
url = "{{baseUrl}}/webhooks"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/webhooks"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/webhooks");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/webhooks HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/webhooks")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks"))
.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}}/webhooks")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/webhooks")
.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}}/webhooks');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/webhooks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/webhooks';
const options = {method: 'GET'};
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}}/webhooks',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhooks")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/webhooks',
headers: {}
};
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}}/webhooks'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/webhooks');
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}}/webhooks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhooks"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/webhooks" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/webhooks');
echo $response->getBody();
setUrl('{{baseUrl}}/webhooks');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/webhooks');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhooks' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/webhooks")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/webhooks"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/webhooks"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/webhooks') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/webhooks
http GET {{baseUrl}}/webhooks
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/webhooks
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
DELETE
Remove webhook
{{baseUrl}}/webhooks/:webhook_id
QUERY PARAMS
webhook_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks/:webhook_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/webhooks/:webhook_id")
require "http/client"
url = "{{baseUrl}}/webhooks/:webhook_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/webhooks/:webhook_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/webhooks/:webhook_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks/:webhook_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/webhooks/:webhook_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/webhooks/:webhook_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks/:webhook_id"))
.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}}/webhooks/:webhook_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/webhooks/:webhook_id")
.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}}/webhooks/:webhook_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/webhooks/:webhook_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/webhooks/:webhook_id';
const options = {method: 'DELETE'};
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}}/webhooks/:webhook_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhooks/:webhook_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/webhooks/:webhook_id',
headers: {}
};
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}}/webhooks/:webhook_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/webhooks/:webhook_id');
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}}/webhooks/:webhook_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks/:webhook_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhooks/:webhook_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
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}}/webhooks/:webhook_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/webhooks/:webhook_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/webhooks/:webhook_id');
echo $response->getBody();
setUrl('{{baseUrl}}/webhooks/:webhook_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/webhooks/:webhook_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhooks/:webhook_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks/:webhook_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/webhooks/:webhook_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/webhooks/:webhook_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/webhooks/:webhook_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhooks/:webhook_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/webhooks/:webhook_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks/:webhook_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/webhooks/:webhook_id
http DELETE {{baseUrl}}/webhooks/:webhook_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/webhooks/:webhook_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks/:webhook_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
PUT
Update webhook
{{baseUrl}}/webhooks/:webhook_id
QUERY PARAMS
webhook_id
BODY json
{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks/:webhook_id");
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 \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/webhooks/:webhook_id" {:content-type :json
:form-params {:address ""
:target {:id ""
:type ""}
:triggers []}})
require "http/client"
url = "{{baseUrl}}/webhooks/:webhook_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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}}/webhooks/:webhook_id"),
Content = new StringContent("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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}}/webhooks/:webhook_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks/:webhook_id"
payload := strings.NewReader("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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/webhooks/:webhook_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 85
{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/webhooks/:webhook_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks/:webhook_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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 \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/webhooks/:webhook_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/webhooks/:webhook_id")
.header("content-type", "application/json")
.body("{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}")
.asString();
const data = JSON.stringify({
address: '',
target: {
id: '',
type: ''
},
triggers: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/webhooks/:webhook_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/webhooks/:webhook_id',
headers: {'content-type': 'application/json'},
data: {address: '', target: {id: '', type: ''}, triggers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/webhooks/:webhook_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"address":"","target":{"id":"","type":""},"triggers":[]}'
};
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}}/webhooks/:webhook_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address": "",\n "target": {\n "id": "",\n "type": ""\n },\n "triggers": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/webhooks/:webhook_id")
.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/webhooks/:webhook_id',
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({address: '', target: {id: '', type: ''}, triggers: []}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/webhooks/:webhook_id',
headers: {'content-type': 'application/json'},
body: {address: '', target: {id: '', type: ''}, triggers: []},
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}}/webhooks/:webhook_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address: '',
target: {
id: '',
type: ''
},
triggers: []
});
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}}/webhooks/:webhook_id',
headers: {'content-type': 'application/json'},
data: {address: '', target: {id: '', type: ''}, triggers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks/:webhook_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"address":"","target":{"id":"","type":""},"triggers":[]}'
};
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 = @{ @"address": @"",
@"target": @{ @"id": @"", @"type": @"" },
@"triggers": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhooks/:webhook_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}}/webhooks/:webhook_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/webhooks/:webhook_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([
'address' => '',
'target' => [
'id' => '',
'type' => ''
],
'triggers' => [
]
]),
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}}/webhooks/:webhook_id', [
'body' => '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/webhooks/:webhook_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address' => '',
'target' => [
'id' => '',
'type' => ''
],
'triggers' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address' => '',
'target' => [
'id' => '',
'type' => ''
],
'triggers' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/webhooks/:webhook_id');
$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}}/webhooks/:webhook_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks/:webhook_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/webhooks/:webhook_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/webhooks/:webhook_id"
payload = {
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/webhooks/:webhook_id"
payload <- "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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}}/webhooks/:webhook_id")
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 \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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/webhooks/:webhook_id') do |req|
req.body = "{\n \"address\": \"\",\n \"target\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"triggers\": []\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}}/webhooks/:webhook_id";
let payload = json!({
"address": "",
"target": json!({
"id": "",
"type": ""
}),
"triggers": ()
});
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}}/webhooks/:webhook_id \
--header 'content-type: application/json' \
--data '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}'
echo '{
"address": "",
"target": {
"id": "",
"type": ""
},
"triggers": []
}' | \
http PUT {{baseUrl}}/webhooks/:webhook_id \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "address": "",\n "target": {\n "id": "",\n "type": ""\n },\n "triggers": []\n}' \
--output-document \
- {{baseUrl}}/webhooks/:webhook_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address": "",
"target": [
"id": "",
"type": ""
],
"triggers": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks/:webhook_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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
List workflows
{{baseUrl}}/workflows
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/workflows?folder_id=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/workflows" {:query-params {:folder_id ""}})
require "http/client"
url = "{{baseUrl}}/workflows?folder_id="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/workflows?folder_id="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/workflows?folder_id=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/workflows?folder_id="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/workflows?folder_id= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/workflows?folder_id=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/workflows?folder_id="))
.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}}/workflows?folder_id=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/workflows?folder_id=")
.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}}/workflows?folder_id=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/workflows',
params: {folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/workflows?folder_id=';
const options = {method: 'GET'};
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}}/workflows?folder_id=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/workflows?folder_id=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/workflows?folder_id=',
headers: {}
};
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}}/workflows',
qs: {folder_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/workflows');
req.query({
folder_id: ''
});
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}}/workflows',
params: {folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/workflows?folder_id=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/workflows?folder_id="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/workflows?folder_id=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/workflows?folder_id=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/workflows?folder_id=');
echo $response->getBody();
setUrl('{{baseUrl}}/workflows');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'folder_id' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/workflows');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'folder_id' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/workflows?folder_id=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/workflows?folder_id=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/workflows?folder_id=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/workflows"
querystring = {"folder_id":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/workflows"
queryString <- list(folder_id = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/workflows?folder_id=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/workflows') do |req|
req.params['folder_id'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/workflows";
let querystring = [
("folder_id", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/workflows?folder_id='
http GET '{{baseUrl}}/workflows?folder_id='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/workflows?folder_id='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/workflows?folder_id=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Starts workflow based on request body
{{baseUrl}}/workflows/:workflow_id/start
QUERY PARAMS
workflow_id
BODY json
{
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/workflows/:workflow_id/start");
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 \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/workflows/:workflow_id/start" {:content-type :json
:form-params {:files [{:id ""
:type ""}]
:flow {:id ""
:type ""}
:folder {:id ""
:type ""}
:outcomes [{:id ""
:parameter ""
:type ""}]
:type ""}})
require "http/client"
url = "{{baseUrl}}/workflows/:workflow_id/start"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\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}}/workflows/:workflow_id/start"),
Content = new StringContent("{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\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}}/workflows/:workflow_id/start");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/workflows/:workflow_id/start"
payload := strings.NewReader("{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/workflows/:workflow_id/start HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 262
{
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/workflows/:workflow_id/start")
.setHeader("content-type", "application/json")
.setBody("{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/workflows/:workflow_id/start"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\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 \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/workflows/:workflow_id/start")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/workflows/:workflow_id/start")
.header("content-type", "application/json")
.body("{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}")
.asString();
const data = JSON.stringify({
files: [
{
id: '',
type: ''
}
],
flow: {
id: '',
type: ''
},
folder: {
id: '',
type: ''
},
outcomes: [
{
id: '',
parameter: '',
type: ''
}
],
type: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/workflows/:workflow_id/start');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/workflows/:workflow_id/start',
headers: {'content-type': 'application/json'},
data: {
files: [{id: '', type: ''}],
flow: {id: '', type: ''},
folder: {id: '', type: ''},
outcomes: [{id: '', parameter: '', type: ''}],
type: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/workflows/:workflow_id/start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"files":[{"id":"","type":""}],"flow":{"id":"","type":""},"folder":{"id":"","type":""},"outcomes":[{"id":"","parameter":"","type":""}],"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}}/workflows/:workflow_id/start',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "files": [\n {\n "id": "",\n "type": ""\n }\n ],\n "flow": {\n "id": "",\n "type": ""\n },\n "folder": {\n "id": "",\n "type": ""\n },\n "outcomes": [\n {\n "id": "",\n "parameter": "",\n "type": ""\n }\n ],\n "type": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/workflows/:workflow_id/start")
.post(body)
.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/workflows/:workflow_id/start',
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({
files: [{id: '', type: ''}],
flow: {id: '', type: ''},
folder: {id: '', type: ''},
outcomes: [{id: '', parameter: '', type: ''}],
type: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/workflows/:workflow_id/start',
headers: {'content-type': 'application/json'},
body: {
files: [{id: '', type: ''}],
flow: {id: '', type: ''},
folder: {id: '', type: ''},
outcomes: [{id: '', parameter: '', type: ''}],
type: ''
},
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}}/workflows/:workflow_id/start');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
files: [
{
id: '',
type: ''
}
],
flow: {
id: '',
type: ''
},
folder: {
id: '',
type: ''
},
outcomes: [
{
id: '',
parameter: '',
type: ''
}
],
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: 'POST',
url: '{{baseUrl}}/workflows/:workflow_id/start',
headers: {'content-type': 'application/json'},
data: {
files: [{id: '', type: ''}],
flow: {id: '', type: ''},
folder: {id: '', type: ''},
outcomes: [{id: '', parameter: '', type: ''}],
type: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/workflows/:workflow_id/start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"files":[{"id":"","type":""}],"flow":{"id":"","type":""},"folder":{"id":"","type":""},"outcomes":[{"id":"","parameter":"","type":""}],"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": @"application/json" };
NSDictionary *parameters = @{ @"files": @[ @{ @"id": @"", @"type": @"" } ],
@"flow": @{ @"id": @"", @"type": @"" },
@"folder": @{ @"id": @"", @"type": @"" },
@"outcomes": @[ @{ @"id": @"", @"parameter": @"", @"type": @"" } ],
@"type": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/workflows/:workflow_id/start"]
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}}/workflows/:workflow_id/start" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/workflows/:workflow_id/start",
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([
'files' => [
[
'id' => '',
'type' => ''
]
],
'flow' => [
'id' => '',
'type' => ''
],
'folder' => [
'id' => '',
'type' => ''
],
'outcomes' => [
[
'id' => '',
'parameter' => '',
'type' => ''
]
],
'type' => ''
]),
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('POST', '{{baseUrl}}/workflows/:workflow_id/start', [
'body' => '{
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/workflows/:workflow_id/start');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'files' => [
[
'id' => '',
'type' => ''
]
],
'flow' => [
'id' => '',
'type' => ''
],
'folder' => [
'id' => '',
'type' => ''
],
'outcomes' => [
[
'id' => '',
'parameter' => '',
'type' => ''
]
],
'type' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'files' => [
[
'id' => '',
'type' => ''
]
],
'flow' => [
'id' => '',
'type' => ''
],
'folder' => [
'id' => '',
'type' => ''
],
'outcomes' => [
[
'id' => '',
'parameter' => '',
'type' => ''
]
],
'type' => ''
]));
$request->setRequestUrl('{{baseUrl}}/workflows/:workflow_id/start');
$request->setRequestMethod('POST');
$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}}/workflows/:workflow_id/start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/workflows/:workflow_id/start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/workflows/:workflow_id/start", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/workflows/:workflow_id/start"
payload = {
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/workflows/:workflow_id/start"
payload <- "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\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}}/workflows/:workflow_id/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\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/workflows/:workflow_id/start') do |req|
req.body = "{\n \"files\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"flow\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"folder\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"outcomes\": [\n {\n \"id\": \"\",\n \"parameter\": \"\",\n \"type\": \"\"\n }\n ],\n \"type\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/workflows/:workflow_id/start";
let payload = json!({
"files": (
json!({
"id": "",
"type": ""
})
),
"flow": json!({
"id": "",
"type": ""
}),
"folder": json!({
"id": "",
"type": ""
}),
"outcomes": (
json!({
"id": "",
"parameter": "",
"type": ""
})
),
"type": ""
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/workflows/:workflow_id/start \
--header 'content-type: application/json' \
--data '{
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}'
echo '{
"files": [
{
"id": "",
"type": ""
}
],
"flow": {
"id": "",
"type": ""
},
"folder": {
"id": "",
"type": ""
},
"outcomes": [
{
"id": "",
"parameter": "",
"type": ""
}
],
"type": ""
}' | \
http POST {{baseUrl}}/workflows/:workflow_id/start \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "files": [\n {\n "id": "",\n "type": ""\n }\n ],\n "flow": {\n "id": "",\n "type": ""\n },\n "folder": {\n "id": "",\n "type": ""\n },\n "outcomes": [\n {\n "id": "",\n "parameter": "",\n "type": ""\n }\n ],\n "type": ""\n}' \
--output-document \
- {{baseUrl}}/workflows/:workflow_id/start
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"files": [
[
"id": "",
"type": ""
]
],
"flow": [
"id": "",
"type": ""
],
"folder": [
"id": "",
"type": ""
],
"outcomes": [
[
"id": "",
"parameter": "",
"type": ""
]
],
"type": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/workflows/:workflow_id/start")! 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
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
POST
Create zip download
{{baseUrl}}/zip_downloads
BODY json
{
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/zip_downloads");
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 \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/zip_downloads" {:content-type :json
:form-params {:download_file_name ""
:items [{:id ""
:type ""}]}})
require "http/client"
url = "{{baseUrl}}/zip_downloads"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\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}}/zip_downloads"),
Content = new StringContent("{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\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}}/zip_downloads");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/zip_downloads"
payload := strings.NewReader("{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/zip_downloads HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 93
{
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/zip_downloads")
.setHeader("content-type", "application/json")
.setBody("{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/zip_downloads"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\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 \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/zip_downloads")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/zip_downloads")
.header("content-type", "application/json")
.body("{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}")
.asString();
const data = JSON.stringify({
download_file_name: '',
items: [
{
id: '',
type: ''
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/zip_downloads');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/zip_downloads',
headers: {'content-type': 'application/json'},
data: {download_file_name: '', items: [{id: '', type: ''}]}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/zip_downloads';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"download_file_name":"","items":[{"id":"","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}}/zip_downloads',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "download_file_name": "",\n "items": [\n {\n "id": "",\n "type": ""\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 \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/zip_downloads")
.post(body)
.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/zip_downloads',
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({download_file_name: '', items: [{id: '', type: ''}]}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/zip_downloads',
headers: {'content-type': 'application/json'},
body: {download_file_name: '', items: [{id: '', type: ''}]},
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}}/zip_downloads');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
download_file_name: '',
items: [
{
id: '',
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: 'POST',
url: '{{baseUrl}}/zip_downloads',
headers: {'content-type': 'application/json'},
data: {download_file_name: '', items: [{id: '', type: ''}]}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/zip_downloads';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"download_file_name":"","items":[{"id":"","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": @"application/json" };
NSDictionary *parameters = @{ @"download_file_name": @"",
@"items": @[ @{ @"id": @"", @"type": @"" } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/zip_downloads"]
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}}/zip_downloads" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/zip_downloads",
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([
'download_file_name' => '',
'items' => [
[
'id' => '',
'type' => ''
]
]
]),
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('POST', '{{baseUrl}}/zip_downloads', [
'body' => '{
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/zip_downloads');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'download_file_name' => '',
'items' => [
[
'id' => '',
'type' => ''
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'download_file_name' => '',
'items' => [
[
'id' => '',
'type' => ''
]
]
]));
$request->setRequestUrl('{{baseUrl}}/zip_downloads');
$request->setRequestMethod('POST');
$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}}/zip_downloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/zip_downloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/zip_downloads", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/zip_downloads"
payload = {
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/zip_downloads"
payload <- "{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\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}}/zip_downloads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\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.post('/baseUrl/zip_downloads') do |req|
req.body = "{\n \"download_file_name\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/zip_downloads";
let payload = json!({
"download_file_name": "",
"items": (
json!({
"id": "",
"type": ""
})
)
});
let mut headers = reqwest::header::HeaderMap::new();
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}}/zip_downloads \
--header 'content-type: application/json' \
--data '{
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}'
echo '{
"download_file_name": "",
"items": [
{
"id": "",
"type": ""
}
]
}' | \
http POST {{baseUrl}}/zip_downloads \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "download_file_name": "",\n "items": [\n {\n "id": "",\n "type": ""\n }\n ]\n}' \
--output-document \
- {{baseUrl}}/zip_downloads
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"download_file_name": "",
"items": [
[
"id": "",
"type": ""
]
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/zip_downloads")! 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
{
"download_url": "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content",
"expires_at": "2020-07-22T11:26:08Z",
"name_conflicts": [
[
{
"download_name": "3aa6a7.pdf",
"id": "12345",
"original_name": "Report.pdf",
"type": "file"
},
{
"download_name": "5d53f2.pdf",
"id": "34325",
"original_name": "Report.pdf",
"type": "file"
}
]
],
"status_url": "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
GET
Download zip archive
{{baseUrl}}/zip_downloads/:zip_download_id/content
QUERY PARAMS
zip_download_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/zip_downloads/:zip_download_id/content");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/zip_downloads/:zip_download_id/content")
require "http/client"
url = "{{baseUrl}}/zip_downloads/:zip_download_id/content"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/zip_downloads/:zip_download_id/content"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/zip_downloads/:zip_download_id/content");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/zip_downloads/:zip_download_id/content"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/zip_downloads/:zip_download_id/content HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/zip_downloads/:zip_download_id/content")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/zip_downloads/:zip_download_id/content"))
.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}}/zip_downloads/:zip_download_id/content")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/zip_downloads/:zip_download_id/content")
.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}}/zip_downloads/:zip_download_id/content');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/zip_downloads/:zip_download_id/content'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/zip_downloads/:zip_download_id/content';
const options = {method: 'GET'};
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}}/zip_downloads/:zip_download_id/content',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/zip_downloads/:zip_download_id/content")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/zip_downloads/:zip_download_id/content',
headers: {}
};
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}}/zip_downloads/:zip_download_id/content'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/zip_downloads/:zip_download_id/content');
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}}/zip_downloads/:zip_download_id/content'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/zip_downloads/:zip_download_id/content';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/zip_downloads/:zip_download_id/content"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/zip_downloads/:zip_download_id/content" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/zip_downloads/:zip_download_id/content",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/zip_downloads/:zip_download_id/content');
echo $response->getBody();
setUrl('{{baseUrl}}/zip_downloads/:zip_download_id/content');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/zip_downloads/:zip_download_id/content');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/zip_downloads/:zip_download_id/content' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/zip_downloads/:zip_download_id/content' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/zip_downloads/:zip_download_id/content")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/zip_downloads/:zip_download_id/content"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/zip_downloads/:zip_download_id/content"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/zip_downloads/:zip_download_id/content")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/zip_downloads/:zip_download_id/content') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/zip_downloads/:zip_download_id/content";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/zip_downloads/:zip_download_id/content
http GET {{baseUrl}}/zip_downloads/:zip_download_id/content
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/zip_downloads/:zip_download_id/content
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/zip_downloads/:zip_download_id/content")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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 zip download status
{{baseUrl}}/zip_downloads/:zip_download_id/status
QUERY PARAMS
zip_download_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/zip_downloads/:zip_download_id/status");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/zip_downloads/:zip_download_id/status")
require "http/client"
url = "{{baseUrl}}/zip_downloads/:zip_download_id/status"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/zip_downloads/:zip_download_id/status"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/zip_downloads/:zip_download_id/status");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/zip_downloads/:zip_download_id/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/zip_downloads/:zip_download_id/status HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/zip_downloads/:zip_download_id/status")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/zip_downloads/:zip_download_id/status"))
.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}}/zip_downloads/:zip_download_id/status")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/zip_downloads/:zip_download_id/status")
.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}}/zip_downloads/:zip_download_id/status');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/zip_downloads/:zip_download_id/status'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/zip_downloads/:zip_download_id/status';
const options = {method: 'GET'};
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}}/zip_downloads/:zip_download_id/status',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/zip_downloads/:zip_download_id/status")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/zip_downloads/:zip_download_id/status',
headers: {}
};
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}}/zip_downloads/:zip_download_id/status'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/zip_downloads/:zip_download_id/status');
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}}/zip_downloads/:zip_download_id/status'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/zip_downloads/:zip_download_id/status';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/zip_downloads/:zip_download_id/status"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/zip_downloads/:zip_download_id/status" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/zip_downloads/:zip_download_id/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/zip_downloads/:zip_download_id/status');
echo $response->getBody();
setUrl('{{baseUrl}}/zip_downloads/:zip_download_id/status');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/zip_downloads/:zip_download_id/status');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/zip_downloads/:zip_download_id/status' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/zip_downloads/:zip_download_id/status' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/zip_downloads/:zip_download_id/status")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/zip_downloads/:zip_download_id/status"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/zip_downloads/:zip_download_id/status"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/zip_downloads/:zip_download_id/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/zip_downloads/:zip_download_id/status') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/zip_downloads/:zip_download_id/status";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/zip_downloads/:zip_download_id/status
http GET {{baseUrl}}/zip_downloads/:zip_download_id/status
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/zip_downloads/:zip_download_id/status
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/zip_downloads/:zip_download_id/status")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"downloaded_file_count": 10,
"skipped_file_count": 5,
"skipped_folder_count": 5,
"state": "success",
"total_file_count": 20
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "item_name_invalid",
"context_info": {
"message": "Something went wrong."
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"message": "Method Not Allowed",
"request_id": "abcdef123456",
"status": 400,
"type": "error"
}