(experimental) Create calendar
curl --request POST \
--url http://10.2.4.166:8080/composer/api/calendars \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"type": "MONTH_SHIFT",
"name": "Calendar name",
"monthShift": -4
}
'import requests
url = "http://10.2.4.166:8080/composer/api/calendars"
payload = {
"type": "MONTH_SHIFT",
"name": "Calendar name",
"monthShift": -4
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({type: 'MONTH_SHIFT', name: 'Calendar name', monthShift: -4})
};
fetch('http://10.2.4.166:8080/composer/api/calendars', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/calendars",
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([
'type' => 'MONTH_SHIFT',
'name' => 'Calendar name',
'monthShift' => -4
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/calendars"
payload := strings.NewReader("{\n \"type\": \"MONTH_SHIFT\",\n \"name\": \"Calendar name\",\n \"monthShift\": -4\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/calendars")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"type\": \"MONTH_SHIFT\",\n \"name\": \"Calendar name\",\n \"monthShift\": -4\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/calendars")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"type\": \"MONTH_SHIFT\",\n \"name\": \"Calendar name\",\n \"monthShift\": -4\n}"
response = http.request(request)
puts response.read_body{
"type": "MONTH_SHIFT",
"name": "Calendar name",
"id": "<string>",
"monthShift": -4,
"fiscal445": {
"yearEndWeekDay": "MONDAY",
"yearEndsInLastWeek": true,
"yearEndIsoMonth": "JUNE",
"quarterType": "QUARTER_445_WEEKS",
"leapWeekInMonth": 12
},
"auditable": {
"createdByUserId": "59ba04795b542f60838ce0e1",
"createdByUserName": "user_name",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedByUserId": "59ba04795b542f60838ce0e2",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"error": "<string>",
"message": "<string>",
"path": "<string>"
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}(experimental) Create calendar
Requires ADMINISTER_CALENDARS role
(experimental) Create calendar
curl --request POST \
--url http://10.2.4.166:8080/composer/api/calendars \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"type": "MONTH_SHIFT",
"name": "Calendar name",
"monthShift": -4
}
'import requests
url = "http://10.2.4.166:8080/composer/api/calendars"
payload = {
"type": "MONTH_SHIFT",
"name": "Calendar name",
"monthShift": -4
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({type: 'MONTH_SHIFT', name: 'Calendar name', monthShift: -4})
};
fetch('http://10.2.4.166:8080/composer/api/calendars', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/calendars",
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([
'type' => 'MONTH_SHIFT',
'name' => 'Calendar name',
'monthShift' => -4
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/calendars"
payload := strings.NewReader("{\n \"type\": \"MONTH_SHIFT\",\n \"name\": \"Calendar name\",\n \"monthShift\": -4\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/calendars")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"type\": \"MONTH_SHIFT\",\n \"name\": \"Calendar name\",\n \"monthShift\": -4\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/calendars")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"type\": \"MONTH_SHIFT\",\n \"name\": \"Calendar name\",\n \"monthShift\": -4\n}"
response = http.request(request)
puts response.read_body{
"type": "MONTH_SHIFT",
"name": "Calendar name",
"id": "<string>",
"monthShift": -4,
"fiscal445": {
"yearEndWeekDay": "MONDAY",
"yearEndsInLastWeek": true,
"yearEndIsoMonth": "JUNE",
"quarterType": "QUARTER_445_WEEKS",
"leapWeekInMonth": 12
},
"auditable": {
"createdByUserId": "59ba04795b542f60838ce0e1",
"createdByUserName": "user_name",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedByUserId": "59ba04795b542f60838ce0e2",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"error": "<string>",
"message": "<string>",
"path": "<string>"
}{
"error": "<string>",
"details": "<string>",
"message": "<string>",
"path": "<string>",
"status": "<string>",
"code": "<string>",
"errorCode": "<string>",
"timestamp": "<string>",
"problems": [
{
"name": "<string>",
"message": "<string>",
"level": "ERROR",
"dependencies": {}
}
]
}Authorizations
HTTP Basic authentication using global administrator credentials (username and password).
Body
application/vnd.composer.v3+json
(experimental) Calendar Resource object
Defines calendar type
Available options:
MONTH_SHIFT, FISCAL_445 Example:
"MONTH_SHIFT"
Defines unique calendar name across account
Required string length:
1 - 255Example:
"Calendar name"
(Month shift type specific param) Defines the difference in months between a start month of this and the default calendar. Should contain an integer value from -11 to 11 excluding zero.
Example:
-4
(Fiscal445 type specific param) Defines the week-based fiscal 445 calendar configuration.
Show child attributes
Show child attributes
Response
The calendar was created
(experimental) Calendar Resource object
Defines calendar type
Available options:
MONTH_SHIFT, FISCAL_445 Example:
"MONTH_SHIFT"
Defines unique calendar name across account
Required string length:
1 - 255Example:
"Calendar name"
Defines calendar identifier
(Month shift type specific param) Defines the difference in months between a start month of this and the default calendar. Should contain an integer value from -11 to 11 excluding zero.
Example:
-4
(Fiscal445 type specific param) Defines the week-based fiscal 445 calendar configuration.
Show child attributes
Show child attributes
Contains information about users and time of creating and updating this object
Show child attributes
Show child attributes
Was this page helpful?