Creates a new board.
curl --request POST \
--url https://{install}/api/board \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": "<string>",
"name": "<string>",
"description": "<string>",
"container": [
"<string>"
],
"resource": [
"<string>"
],
"budgetHours": 123,
"budgetChange": [
{
"id": "<string>",
"reasonId": "<string>",
"userId": "<string>",
"initials": "<string>",
"dated": "2023-11-07T05:31:56Z",
"changeDelta": 123
}
],
"locked": true,
"archived": true,
"role": [
{
"role": 123,
"userGroup": [
"<string>"
]
}
],
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
'import requests
url = "https://{install}/api/board"
payload = {
"entity": "<string>",
"name": "<string>",
"description": "<string>",
"container": ["<string>"],
"resource": ["<string>"],
"budgetHours": 123,
"budgetChange": [
{
"id": "<string>",
"reasonId": "<string>",
"userId": "<string>",
"initials": "<string>",
"dated": "2023-11-07T05:31:56Z",
"changeDelta": 123
}
],
"locked": True,
"archived": True,
"role": [
{
"role": 123,
"userGroup": ["<string>"]
}
],
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: '<string>',
name: '<string>',
description: '<string>',
container: ['<string>'],
resource: ['<string>'],
budgetHours: 123,
budgetChange: [
{
id: '<string>',
reasonId: '<string>',
userId: '<string>',
initials: '<string>',
dated: '2023-11-07T05:31:56Z',
changeDelta: 123
}
],
locked: true,
archived: true,
role: [{role: 123, userGroup: ['<string>']}],
tenantId: '<string>',
id: '<string>',
created: '2023-11-07T05:31:56Z',
createdBy: '<string>',
updated: '2023-11-07T05:31:56Z',
updatedBy: '<string>',
deleted: true
})
};
fetch('https://{install}/api/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/board");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/board",
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([
'entity' => '<string>',
'name' => '<string>',
'description' => '<string>',
'container' => [
'<string>'
],
'resource' => [
'<string>'
],
'budgetHours' => 123,
'budgetChange' => [
[
'id' => '<string>',
'reasonId' => '<string>',
'userId' => '<string>',
'initials' => '<string>',
'dated' => '2023-11-07T05:31:56Z',
'changeDelta' => 123
]
],
'locked' => true,
'archived' => true,
'role' => [
[
'role' => 123,
'userGroup' => [
'<string>'
]
]
],
'tenantId' => '<string>',
'id' => '<string>',
'created' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'updated' => '2023-11-07T05:31:56Z',
'updatedBy' => '<string>',
'deleted' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{install}/api/board"
payload := strings.NewReader("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{install}/api/board")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}"
response = http.request(request)
puts response.read_bodyBoards
Creates a new board.
POST
/
api
/
board
Creates a new board.
curl --request POST \
--url https://{install}/api/board \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": "<string>",
"name": "<string>",
"description": "<string>",
"container": [
"<string>"
],
"resource": [
"<string>"
],
"budgetHours": 123,
"budgetChange": [
{
"id": "<string>",
"reasonId": "<string>",
"userId": "<string>",
"initials": "<string>",
"dated": "2023-11-07T05:31:56Z",
"changeDelta": 123
}
],
"locked": true,
"archived": true,
"role": [
{
"role": 123,
"userGroup": [
"<string>"
]
}
],
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
'import requests
url = "https://{install}/api/board"
payload = {
"entity": "<string>",
"name": "<string>",
"description": "<string>",
"container": ["<string>"],
"resource": ["<string>"],
"budgetHours": 123,
"budgetChange": [
{
"id": "<string>",
"reasonId": "<string>",
"userId": "<string>",
"initials": "<string>",
"dated": "2023-11-07T05:31:56Z",
"changeDelta": 123
}
],
"locked": True,
"archived": True,
"role": [
{
"role": 123,
"userGroup": ["<string>"]
}
],
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: '<string>',
name: '<string>',
description: '<string>',
container: ['<string>'],
resource: ['<string>'],
budgetHours: 123,
budgetChange: [
{
id: '<string>',
reasonId: '<string>',
userId: '<string>',
initials: '<string>',
dated: '2023-11-07T05:31:56Z',
changeDelta: 123
}
],
locked: true,
archived: true,
role: [{role: 123, userGroup: ['<string>']}],
tenantId: '<string>',
id: '<string>',
created: '2023-11-07T05:31:56Z',
createdBy: '<string>',
updated: '2023-11-07T05:31:56Z',
updatedBy: '<string>',
deleted: true
})
};
fetch('https://{install}/api/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/board");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/board",
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([
'entity' => '<string>',
'name' => '<string>',
'description' => '<string>',
'container' => [
'<string>'
],
'resource' => [
'<string>'
],
'budgetHours' => 123,
'budgetChange' => [
[
'id' => '<string>',
'reasonId' => '<string>',
'userId' => '<string>',
'initials' => '<string>',
'dated' => '2023-11-07T05:31:56Z',
'changeDelta' => 123
]
],
'locked' => true,
'archived' => true,
'role' => [
[
'role' => 123,
'userGroup' => [
'<string>'
]
]
],
'tenantId' => '<string>',
'id' => '<string>',
'created' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'updated' => '2023-11-07T05:31:56Z',
'updatedBy' => '<string>',
'deleted' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{install}/api/board"
payload := strings.NewReader("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{install}/api/board")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"container\": [\n \"<string>\"\n ],\n \"resource\": [\n \"<string>\"\n ],\n \"budgetHours\": 123,\n \"budgetChange\": [\n {\n \"id\": \"<string>\",\n \"reasonId\": \"<string>\",\n \"userId\": \"<string>\",\n \"initials\": \"<string>\",\n \"dated\": \"2023-11-07T05:31:56Z\",\n \"changeDelta\": 123\n }\n ],\n \"locked\": true,\n \"archived\": true,\n \"role\": [\n {\n \"role\": 123,\n \"userGroup\": [\n \"<string>\"\n ]\n }\n ],\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.
Body
application/jsonapplication/*+json
The board data to create. Container accepts container IDs. Resource accepts user group IDs (ConfigUserGroup).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Board created successfully.
⌘I