Jump to

• Request
• Response
• Examples

Get a single shift project calendar

get

/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectCalendars/{CalendarId}

Request

Path Parameters

• CalendarId(required): integer(int64)
  Unique identifier of the calendar.
• ProjectId(required): integer(int64)
  Unique identifier of the project.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : projectPlans-ProjectCalendars-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Indicator

  Read Only: true

  Indicates if the calendar is active.
• CalendarExceptions: array Calendar Exceptions
  Title: Calendar Exceptions

  The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
• CalendarId: integer (int64)
  Title: Calendar ID

  Read Only: true

  Unique identifier of the calendar.
• CalendarName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the calendar.
• CategoryCode: string
  Title: Calendar Category Code

  Read Only: true

  Maximum Length: 30

  The category of the use of the calendar.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates the resource who created the row of data.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the row of data was created.
• Description: string
  Title: Calendar Description

  Read Only: true

  Maximum Length: 2000

  Description of the calendar.
• EffectiveFromDate: string (date)
  Title: Effective from Date

  Read Only: true

  The date for which the calendar starts to be effective.
• EffectiveToDate: string (date)
  Title: Effective to Date

  Read Only: true

  The inclusive last date of the effectivity of the calendar.
• FirstDayOfWeek: integer
  Title: First Day of Week for Calendar

  Read Only: true

  The index of the first day in the week: 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. The default value is 2.
• FridayWorkFlag: boolean
  Title: Friday Work Indicator

  Read Only: true

  Indicates if Fridays workable. True if it is workable, False if it is not.
• HoursPerDay: number
  Title: Hours per Day

  Read Only: true

  Number of hours used to calculate when one day is entered. Value depends on the number of hours of the shift.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the record was last edited.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Indicates who last edited the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MondayWorkFlag: boolean
  Title: Monday Work Indicator

  Read Only: true

  Indicates if Mondays are workable. True if it is workable, False if it is not.
• QuaterlyTypeCode: string
  Title: Quarterly Type Code

  Read Only: true

  Maximum Length: 30

  Indicates the quarter type used for the calendar.
• SaturdayWorkFlag: boolean
  Title: Saturday Work Indicator

  Read Only: true

  Indicates if Saturdays are workable. True if it is workable, False if it is not.
• SundayWorkFlag: boolean
  Title: Sunday Work Indicator

  Read Only: true

  Indicates if Sundays are workable. True if it is workable, False if it is not.
• ThursdayWorkFlag: boolean
  Title: Thursday Work Indicator

  Read Only: true

  Indicates if Thursdays are workable. True if it is workable, False if it is not.
• TuesdayWorkFlag: boolean
  Title: Tuesday Work Indicator

  Read Only: true

  Indicates if Tuesdays are workable. True if it is workable, False if it is not.
• WednesdayWorkFlag: boolean
  Title: Wednesday Work Indicator

  Read Only: true

  Indicates if Wednesdays are workable. True if it is workable, False if it is not.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Calendar Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the use of the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who last edited the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the row of data was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WednesdayWorkFlag":{
            "title":"Wednesday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Wednesdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Calendar Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the resource who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SaturdayWorkFlag":{
            "title":"Saturday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Saturdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuaterlyTypeCode":{
            "title":"Quarterly Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the quarter type used for the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SundayWorkFlag":{
            "title":"Sunday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Sundays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoursPerDay":{
            "title":"Hours per Day",
            "type":"number",
            "description":"Number of hours used to calculate when one day is entered. Value depends on the number of hours of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"Unique identifier of the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalendarExceptions":{
            "title":"Calendar Exceptions",
            "type":"array",
            "description":"The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.",
            "items":{
                "$ref":"#/components/schemas/projectPlans-ProjectCalendars-CalendarExceptions-item-response"
            }
        },
        "MondayWorkFlag":{
            "title":"Monday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Mondays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active Indicator",
            "type":"boolean",
            "description":"Indicates if the calendar is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TuesdayWorkFlag":{
            "title":"Tuesday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Tuesdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveFromDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date for which the calendar starts to be effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FridayWorkFlag":{
            "title":"Friday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Fridays workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveToDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The inclusive last date of the effectivity of the calendar.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ThursdayWorkFlag":{
            "title":"Thursday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Thursdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last edited.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstDayOfWeek":{
            "title":"First Day of Week for Calendar",
            "type":"integer",
            "description":"The index of the first day in the week: 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. The default value is 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Calendar Exceptions

Type: array

Title: Calendar Exceptions

The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.

Show Source

• Array of: object projectPlans-ProjectCalendars-CalendarExceptions-item-response

{
    "title":"Calendar Exceptions",
    "type":"array",
    "description":"The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.",
    "items":{
        "$ref":"#/components/schemas/projectPlans-ProjectCalendars-CalendarExceptions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectPlans-ProjectCalendars-CalendarExceptions-item-response

Type: object

Show Source

• AllDayFlag: boolean
  Title: All Day Exception Indicator

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates if the calendar exception is for the whole day.
• CategoryCode: string
  Title: Calendar Exception Category Code

  Read Only: true

  Maximum Length: 30

  Category code in which the exception falls.
• Code: string
  Title: Calendar Exception Code

  Read Only: true

  Maximum Length: 3

  Code to identify the exception.
• Description: string
  Title: Calendar Exception Description

  Read Only: true

  Maximum Length: 2000

  Description of the exception.
• EndDate: string (date-time)
  Title: Calendar Exception End Date

  Read Only: true

  The inclusive end date of the calendar exception. Value contains time component if the exception is not for all day long.
• ExceptionId: integer (int64)
  Title: Calendar Exception ID

  Read Only: true

  Unique identifier of the exception in the calendar.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Calendar Exception Name

  Read Only: true

  Maximum Length: 240

  Name of the exception.
• PeriodType: string
  Title: Calendar Exception Period Type

  Read Only: true

  Maximum Length: 30

  Indicates if the calendar exception is a workable period or not. Valid values are 'OFF_PERIOD' and 'WORK_PERIOD'.
• StartDate: string (date-time)
  Title: Calendar Exception Start Date

  Read Only: true

  The date on which the calendar exception begins. Value contains time component if the exception is not for all day long.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Calendar Exception Start Date",
            "type":"string",
            "description":"The date on which the calendar exception begins. Value contains time component if the exception is not for all day long.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Calendar Exception Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Category code in which the exception falls.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "title":"Calendar Exception Period Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the calendar exception is a workable period or not. Valid values are 'OFF_PERIOD' and 'WORK_PERIOD'.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Calendar Exception Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExceptionId":{
            "title":"Calendar Exception ID",
            "type":"integer",
            "description":"Unique identifier of the exception in the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllDayFlag":{
            "title":"All Day Exception Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the calendar exception is for the whole day.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "Code":{
            "title":"Calendar Exception Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code to identify the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Calendar Exception End Date",
            "type":"string",
            "description":"The inclusive end date of the calendar exception. Value contains time component if the exception is not for all day long.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Calendar Exception Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the exception.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CalendarExceptions

Operation: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectCalendars/{CalendarId}/child/CalendarExceptions

Parameters:

• CalendarId: $request.path.CalendarId
• ProjectId: $request.path.ProjectId

The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.

Back to Top

Examples

The following example shows how to get a single shift project calendar by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectCalendars/300100010293735/

Response Body Example

The following shows an example of the response body in JSON format.

{
    "CalendarId": 300100010293735,
    "CalendarName": "PJT Standard US Calendar",
    "Description": null,
    "EffectiveFromDate": "2011-01-01",
    "EffectiveToDate": "2025-12-31",
    "CategoryCode": null,
    "QuaterlyTypeCode": null,
    "CreatedBy": "APP_IMPL_CONSULTANT",
    "CreationDate": "2012-05-03T15:11:42+00:00",
    "LastUpdatedBy": "ABRAHAM.MASON",
    "LastUpdateDate": "2019-12-08T07:50:29.251+00:00",
    "FirstDayOfWeek": 7,
    "HoursPerDay": 8,
    "SundayWorkFlag": false,
    "MondayWorkFlag": true,
    "TuesdayWorkFlag": true,
    "WednesdayWorkFlag": true,
    "ThursdayWorkFlag": true,
    "FridayWorkFlag": true,
    "SaturdayWorkFlag": false,
    "ActiveFlag": "true",
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectCalendars/300100010293735",
            "name": "ProjectCalendars",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectCalendars/300100010293735",
            "name": "ProjectCalendars",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843",
            "name": "projectPlans",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectCalendars/300100010293735/child/CalendarExceptions",
            "name": "CalendarExceptions",
            "kind": "collection"
        }
    ]
}

Back to Top