Show Source

• [0]: object ApiEntityCalendar

{
    "title":"List<ApiEntityCalendar>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityCalendar"
    }
}

Show Source

• calendarCode(optional): string
  The unique code for the calendar.
• calendarExceptions(optional): array calendarExceptions
  Unique Items Required: true
• calendarId(optional): integer(int64)
  The unique identifier for the calendar.
• calendarName(optional): string
  The name of the calendar.
• dayHourCount(optional): number(double)
  The number of hours in a day.
• holiday(optional): integer(int64)
  The holiday list assigned to the calendar.
• holidayMoveType(optional): string
  Allowed Values: [ "NONE", "FORWARD", "BACKWARD", "CLOSEST_WORK_DAY" ]

  Specifies a holiday within calendar work time.
• isAssignableToProject(optional): boolean
  Indicates whether or not the calendar can be assigned to a project.
• isAssignableToResource(optional): boolean
  Indicates whether or not the calendar can be assigned to a resource.
• link(optional): string(url)
  Read Only: true
• monthHourCount(optional): number(double)
  The number of hours in a month.
• pushDownType(optional): string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  Specifies how a workspace calendar is shared across child workspaces.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• weekHourCount(optional): number(double)
  The number of hours in a week.
• workspaceId(optional): integer(int64)
  The unique identifier for the workspace for which the calendar belongs.
• workTimeFriday(optional): string
  Friday.
• workTimeMonday(optional): string
  Monday.
• workTimeSaturday(optional): string
  Saturday.
• workTimeSunday(optional): string
  Sunday.
• workTimeThursday(optional): string
  Thursday.
• workTimeTuesday(optional): string
  Tuesday.
• workTimeWednesday(optional): string
  Wednesday.
• yearHourCount(optional): number(double)
  The number of hours in a year.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the workspace for which the calendar belongs."
        },
        "calendarName":{
            "type":"string",
            "description":"The name of the calendar."
        },
        "dayHourCount":{
            "type":"number",
            "format":"double",
            "description":"The number of hours in a day."
        },
        "yearHourCount":{
            "type":"number",
            "format":"double",
            "description":"The number of hours in a year."
        },
        "calendarCode":{
            "type":"string",
            "description":"The unique code for the calendar."
        },
        "calendarId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the calendar."
        },
        "weekHourCount":{
            "type":"number",
            "format":"double",
            "description":"The number of hours in a week."
        },
        "holiday":{
            "type":"integer",
            "format":"int64",
            "description":"The holiday list assigned to the calendar."
        },
        "pushDownType":{
            "type":"string",
            "description":"Specifies how a workspace calendar is shared across child workspaces.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "workTimeTuesday":{
            "type":"string",
            "description":"Tuesday."
        },
        "workTimeMonday":{
            "type":"string",
            "description":"Monday."
        },
        "workTimeWednesday":{
            "type":"string",
            "description":"Wednesday."
        },
        "monthHourCount":{
            "type":"number",
            "format":"double",
            "description":"The number of hours in a month."
        },
        "holidayMoveType":{
            "type":"string",
            "description":"Specifies a holiday within calendar work time.",
            "enum":[
                "NONE",
                "FORWARD",
                "BACKWARD",
                "CLOSEST_WORK_DAY"
            ]
        },
        "workTimeSaturday":{
            "type":"string",
            "description":"Saturday."
        },
        "workTimeSunday":{
            "type":"string",
            "description":"Sunday. "
        },
        "calendarExceptions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCalendarException"
            }
        },
        "workTimeThursday":{
            "type":"string",
            "description":"Thursday."
        },
        "workTimeFriday":{
            "type":"string",
            "description":"Friday."
        },
        "isAssignableToResource":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a resource."
        },
        "isAssignableToProject":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a project."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Show Source

• [0]: object ApiEntityCalendarException

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCalendarException"
    }
}

Show Source

• calendarExceptionId(optional): integer(int64)
  The unique identifier for the calendar exception.
• calendarId(optional): integer(int64)
  The unique identifier for the calendar.
• exceptionDate(optional): 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(optional): string
  The name of the exception for the calendar.
• link(optional): string(url)
  Read Only: true
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workTime(optional): string
  Work time that is non-standard.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "calendarId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the calendar."
        },
        "calendarExceptionId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the calendar exception."
        },
        "exceptionDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar."
        },
        "exceptionName":{
            "type":"string",
            "description":"The name of the exception for the calendar."
        },
        "workTime":{
            "type":"string",
            "description":"Work time that is non-standard."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}