Jump to

• Request
• Response

View Calendar Exceptions

get

/api/restapi/calendar/exception/{calendarId}

This endpoint returns calendar exceptions that meet the following requirements:

• The object is associated with a calendar with an ID value that matches the value of the {calendarId} path parameter.

Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.

Request

Path Parameters

• calendarId(required): integer(int64)
  The system-generated identifier of a calendar exception.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityCalendarException>

Type: array

Title: List<ApiEntityCalendarException>

Show Source

• Array of: object ApiEntityCalendarException
  Title: ApiEntityCalendarException

{
    "title":"List<ApiEntityCalendarException>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCalendarException",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCalendarException

Type: object

Title: ApiEntityCalendarException

Show Source

• calendarCode: string
  Minimum Length: 0

  Maximum Length: 255

  The unique code for the calendar.
• calendarExceptionId: integer (int64)
  The unique identifier for the calendar exception.
• calendarId: integer (int64)
  The unique identifier for the calendar.
• exceptionDate: string (date-time)
  The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar.
• exceptionName: string
  Maximum Length: 60

  The name of the exception for the calendar.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workTime: string
  Maximum Length: 4000

  Work time that is non-standard.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000

{
    "title":"ApiEntityCalendarException",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the exception for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarCode":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The unique code for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionDate":{
            "type":"string",
            "description":"The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workTime":{
            "maxLength":"4000",
            "type":"string",
            "description":"Work time that is non-standard. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarExceptionId":{
            "type":"integer",
            "description":"The unique identifier for the calendar exception.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested calendar exception does not exist, or you do not have access to it.

Back to Top