Jump to

• Request
• Response

View Calendars by Code

get

/api/restapi/calendar/code/{calendarCode}

This endpoint returns calendars that meet the following requirements:

• The object has a code that matches the value of the {calendarCode} path parameter.

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

Request

Path Parameters

• calendarCode(required): string
  The user-specified identifier of a calendar.

Query Parameters

• calendarType(required): string
  Type of Calendar - Workspace or Project.
  This is a required field.

  Default Value: WORKSPACE

  Allowed Values: [ "WORKSPACE", "PROJECT" ]

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<ApiEntityCalendar>

Type: array

Title: List<ApiEntityCalendar>

Show Source

• Array of: object ApiEntityCalendar
  Title: ApiEntityCalendar

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

Nested Schema : ApiEntityCalendar

Type: object

Title: ApiEntityCalendar

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the calendar and the workspace. Possible values are Owned and Inherited.
• calendarCode: string
  Minimum Length: 0

  Maximum Length: 255

  The unique code for the calendar.
• calendarExceptions: array calendarExceptions
  Defines exceptions to the specified calendar.
• calendarId: integer (int64)
  The unique identifier for the calendar.
• calendarName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the calendar.
• dayHourCount: number (double)
  The number of hours in a day.
• holiday: integer (int64)
  The holiday list assigned to the calendar.
• holidayMoveType: string
  Allowed Values: [ "NONE", "FORWARD", "BACKWARD", "CLOSEST_WORK_DAY" ]

  Specifies a holiday within calendar work time.
• isAssignableToProject: boolean
  Indicates whether or not the calendar can be assigned to a project.
• isAssignableToResource: boolean
  Indicates whether or not the calendar can be assigned to a resource.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• monthHourCount: number (double)
  The number of hours in a month.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  Specifies how a workspace calendar is shared across child workspaces.
• updateDate: string (date-time)
  Date when the record was last updated.
• weekHourCount: number (double)
  The number of hours in a week.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
• workTimeFriday: string
  Maximum Length: 48

  The working time for Friday.
  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
• workTimeMonday: string
  Maximum Length: 48

  The working time for Monday.
  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
• workTimeSaturday: string
  Maximum Length: 48

  The working time for Saturday.
  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
• workTimeSunday: string
  Maximum Length: 48

  The working time for Sunday.
  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
• workTimeThursday: string
  Maximum Length: 48

  The working time for Thursday.
  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
• workTimeTuesday: string
  Maximum Length: 48

  The working time for Tuesday.
  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
• workTimeWednesday: string
  Maximum Length: 48

  The working time for Wednesday.
  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
• yearHourCount: number (double)
  The number of hours in a year.

{
    "title":"ApiEntityCalendar",
    "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "isAssignableToResource":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a resource.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"Specifies how a workspace calendar is shared across child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the calendar and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "calendarExceptions":{
            "type":"array",
            "description":"Defines exceptions to the specified calendar.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCalendarException",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workTimeSunday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Sunday. </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"
            ]
        },
        "isAssignableToProject":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a project.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "workTimeMonday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Monday. </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"
            ]
        },
        "workTimeTuesday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Tuesday. </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"
            ]
        },
        "workTimeWednesday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Wednesday. </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"
            ]
        },
        "workTimeThursday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Thursday. </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"
            ]
        },
        "workTimeFriday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Friday. </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"
            ]
        },
        "workTimeSaturday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Saturday. </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"
            ]
        },
        "monthHourCount":{
            "type":"number",
            "description":"The number of hours in a month.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "dayHourCount":{
            "type":"number",
            "description":"The number of hours in a day.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "yearHourCount":{
            "type":"number",
            "description":"The number of hours in a year.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "weekHourCount":{
            "type":"number",
            "description":"The number of hours in a week.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "holidayMoveType":{
            "type":"string",
            "description":"Specifies a holiday within calendar work time.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "FORWARD",
                "BACKWARD",
                "CLOSEST_WORK_DAY"
            ]
        },
        "holiday":{
            "type":"integer",
            "description":"The holiday list assigned to the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : calendarExceptions

Type: array

Defines exceptions to the specified calendar.

Show Source

• Array of: object ApiEntityCalendarException
  Title: ApiEntityCalendarException

{
    "type":"array",
    "description":"Defines exceptions to the specified calendar.",
    "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 does not exist, or you do not have access to it.

Back to Top