Jump to

• Request
• Response

Read Calendars

get

/calendar

Reads Calendar objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<Calendar>

Type: array

Title: List<Calendar>

Show Source

• Array of: object Calendar
  Title: Calendar

  Calendar Entity

{
    "title":"List<Calendar>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Calendar"
    }
}

Nested Schema : Calendar

Type: object

Title: Calendar

Calendar Entity

Show Source

• BaseCalendarObjectId: integer (int32)
  The unique ID of the global calendar to which this calendar is linked. Any changes to the global calendar are automatically propagated to this calendar.
• CreateDate: string (date-time)
  The date this calendar was created.
• CreateUser: string
  The name of the user that created this calendar.
• HolidayOrExceptions: object HolidayOrExceptions
  HolidayOrExceptions
• HoursPerDay: number (double)
  The number of work hours per day. This conversion factor is used for displaying time units and durations in the user's selected display formats.
• HoursPerMonth: number (double)
  The number of work hours per month. This conversion factor is used for displaying time units and durations in the user's selected display formats.
• HoursPerWeek: number (double)
  The number of work hours per week. This conversion factor is used for displaying time units and durations in the user's selected display formats.
• HoursPerYear: number (double)
  The number of work hours per year. This conversion factor is used for displaying time units and durations in the user's selected display formats.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IsDefault: boolean
  The flag that identifies the default global calendar (applies to global calendars only).
• IsPersonal: boolean
  The flag indicating if this calendar is a personal calendar (applies to resource calendars only).
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this calendar was last updated.
• LastUpdateUser: string
  The name of the user that last updated this calendar.
• Name(required): string
  The name of the calendar.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProjectId: string
  The ID for the project for which this change request is associated.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• StandardWorkWeek: object StandardWorkWeek
• Type(required): string
  The calendar type - either 'Global', 'Resource', or 'Project'. 'Global' calendars can be assigned to projects and resources. 'Resource' calendars can be assigned only to resources. 'Project' calendars are specific to projects.

{
    "title":"Calendar",
    "required":[
        "Name",
        "Type"
    ],
    "type":"object",
    "properties":{
        "BaseCalendarObjectId":{
            "type":"integer",
            "description":"The unique ID of the global calendar to which this calendar is linked. Any changes to the global calendar are automatically propagated to this calendar.",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this calendar was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this calendar."
        },
        "HoursPerDay":{
            "type":"number",
            "description":"The number of work hours per day. This conversion factor is used for displaying time units and durations in the user's selected display formats.",
            "format":"double"
        },
        "HoursPerMonth":{
            "type":"number",
            "description":"The number of work hours per month. This conversion factor is used for displaying time units and durations in the user's selected display formats.",
            "format":"double"
        },
        "HoursPerWeek":{
            "type":"number",
            "description":"The number of work hours per week. This conversion factor is used for displaying time units and durations in the user's selected display formats.",
            "format":"double"
        },
        "HoursPerYear":{
            "type":"number",
            "description":"The number of work hours per year. This conversion factor is used for displaying time units and durations in the user's selected display formats.",
            "format":"double"
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsDefault":{
            "type":"boolean",
            "description":"The flag that identifies the default global calendar (applies to global calendars only)."
        },
        "IsPersonal":{
            "type":"boolean",
            "description":"The flag indicating if this calendar is a personal calendar (applies to resource calendars only)."
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this calendar was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this calendar."
        },
        "Name":{
            "type":"string",
            "description":"The name of the calendar."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The ID for the project for which this change request is associated."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "Type":{
            "type":"string",
            "description":"The calendar type - either 'Global', 'Resource', or 'Project'. 'Global' calendars can be assigned to projects and resources. 'Resource' calendars can be assigned only to resources. 'Project' calendars are specific to projects."
        },
        "StandardWorkWeek":{
            "$ref":"#/components/schemas/StandardWorkWeek"
        },
        "HolidayOrExceptions":{
            "$ref":"#/components/schemas/HolidayOrExceptions"
        }
    },
    "description":"Calendar Entity"
}

Nested Schema : HolidayOrExceptions

Type: object

HolidayOrExceptions

Show Source

• HolidayOrException: array HolidayOrException

{
    "type":"object",
    "properties":{
        "HolidayOrException":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HolidayOrException"
            }
        }
    },
    "description":"HolidayOrExceptions"
}

Nested Schema : StandardWorkWeek

Type: object

Show Source

• StandardWorkHours: array StandardWorkHours

{
    "type":"object",
    "properties":{
        "StandardWorkHours":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StandardWorkHours"
            }
        }
    }
}

Nested Schema : HolidayOrException

Type: array

Show Source

• Array of: object HolidayOrException

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/HolidayOrException"
    }
}

Nested Schema : HolidayOrException

Type: object

Show Source

• Date: string (date-time)
• WorkTime: array WorkTime

{
    "type":"object",
    "properties":{
        "Date":{
            "type":"string",
            "format":"date-time"
        },
        "WorkTime":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkTime"
            }
        }
    }
}

Nested Schema : WorkTime

Type: array

Show Source

• Array of: object WorkTime

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkTime"
    }
}

Nested Schema : WorkTime

Type: object

Show Source

• Finish: string (date-time)
• Start: string (date-time)

{
    "type":"object",
    "properties":{
        "Finish":{
            "type":"string",
            "format":"date-time"
        },
        "Start":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : StandardWorkHours

Type: array

Show Source

• Array of: object StandardWorkHours

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StandardWorkHours"
    }
}

Nested Schema : StandardWorkHours

Type: object

Show Source

• DayOfWeek: string
• WorkTime: array WorkTime

{
    "type":"object",
    "properties":{
        "DayOfWeek":{
            "type":"string"
        },
        "WorkTime":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkTime"
            }
        }
    }
}

Nested Schema : WorkTime

Type: array

Show Source

• Array of: object WorkTime

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkTime"
    }
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top