(experimental) Load calendar by its id

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/calendars/{calendarId} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/calendars/{calendarId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/calendars/{calendarId}', 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/{calendarId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/calendars/{calendarId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/calendars/{calendarId}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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) Load calendar by its id

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/calendars/{calendarId} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/calendars/{calendarId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/calendars/{calendarId}', 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/{calendarId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/calendars/{calendarId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/calendars/{calendarId}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Path Parameters

calendarId

string

required

Response

The calendar was retrieved

(experimental) Calendar Resource object

type

enum<string>

required

Defines calendar type

Available options:

MONTH_SHIFT,

FISCAL_445

Example:

"MONTH_SHIFT"

name

string

required

Defines unique calendar name across account

Required string length: 1 - 255

Example:

"Calendar name"

string

read-only

Defines calendar identifier

monthShift

integer<int32>

(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

object

(Fiscal445 type specific param) Defines the week-based fiscal 445 calendar configuration.

Show child attributes

auditable

object

read-only

Contains information about users and time of creating and updating this object

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

(experimental) Load calendar by its id

Authorizations

Path Parameters

Response