1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Enterprise Labor Resources
  4. Project Enterprise Resource Calendars

Get all single shift resource calendars used to schedule or staff a resource

get

/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourceCalendars

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Project Enterprise Labor Resources resource and used to uniquely identify an instance of Project Enterprise Labor Resources. The client should not generate the hash key value. Instead, the client should query on the Project Enterprise Labor Resources collection resource in order to navigate to a specific instance of Project Enterprise Labor Resources to get the hash key.
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the calendar that matches the primary key criteria specified.
      Finder Variables:
      • CalendarId; integer; Unique identifier of the calendar.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActiveFlag; boolean; Indicates if the calendar is active.
    • CalendarId; integer; Unique identifier of the calendar.
    • CategoryCode; string; The category used for the calendar.
    • Description; string; Description of the calendar.
    • EffectiveFromDate; string; The date from which the calendar is effective.
    • EffectiveToDate; string; The inclusive last date of the effectivity of the calendar.
    • FirstDayOfWeek; integer; 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; Indicates if Fridays are workable. True if it's workable, False if it's not.
    • HoursPerDay; number; Number of working hours in a day. Value depends on the number of hours in the shift.
    • MondayWorkFlag; boolean; Indicates if Mondays are workable. True if it is workable, False if it is not.
    • Name; string; Name of the calendar.
    • QuaterlyTypeCode; string; Indicates the quarter type of the calendar.
    • SaturdayWorkFlag; boolean; Indicates if Saturdays are workable. True if it is workable, False if it is not.
    • SundayWorkFlag; boolean; Indicates if Sundays are workable. True if it is workable, False if it is not.
    • ThursdayWorkFlag; boolean; Indicates if Thursdays are workable. True if it is workable, False if it is not.
    • TuesdayWorkFlag; boolean; Indicates if Tuesdays are workable. True if it is workable, False if it is not.
    • WednesdayWorkFlag; boolean; Indicates if Wednesdays are workable. True if it is workable, False if it is not.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : projectEnterpriseLaborResources-ResourceCalendars
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectEnterpriseLaborResources-ResourceCalendars-item-response
Type: object
Show Source
  • Title: Active Indicator
    Read Only: true
    Indicates if the calendar is active.
  • Project Enterprise Resource Calendar Exceptions
    Title: Project Enterprise Resource Calendar Exceptions
    The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
  • Title: Calendar ID
    Read Only: true
    Unique identifier of the calendar.
  • Title: Calendar Category Code
    Read Only: true
    Maximum Length: 30
    The category used for the calendar.
  • Title: Calendar Description
    Read Only: true
    Maximum Length: 2000
    Description of the calendar.
  • Title: Effective from Date
    Read Only: true
    The date from which the calendar is effective.
  • Title: Effective to Date
    Read Only: true
    The inclusive last date of the effectivity of the calendar.
  • 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.
  • Title: Friday Work Indicator
    Read Only: true
    Indicates if Fridays are workable. True if it's workable, False if it's not.
  • Title: Hours per Day
    Read Only: true
    Number of working hours in a day. Value depends on the number of hours in the shift.
  • Links
  • Title: Monday Work Indicator
    Read Only: true
    Indicates if Mondays are workable. True if it is workable, False if it is not.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the calendar.
  • Title: Quarterly Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the quarter type of the calendar.
  • Title: Saturday Work Indicator
    Read Only: true
    Indicates if Saturdays are workable. True if it is workable, False if it is not.
  • Title: Sunday Work Indicator
    Read Only: true
    Indicates if Sundays are workable. True if it is workable, False if it is not.
  • Title: Thursday Work Indicator
    Read Only: true
    Indicates if Thursdays are workable. True if it is workable, False if it is not.
  • Title: Tuesday Work Indicator
    Read Only: true
    Indicates if Tuesdays are workable. True if it is workable, False if it is not.
  • Title: Wednesday Work Indicator
    Read Only: true
    Indicates if Wednesdays are workable. True if it is workable, False if it is not.
Nested Schema : Project Enterprise Resource Calendar Exceptions
Type: array
Title: Project Enterprise Resource Calendar Exceptions
The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
Show Source
Nested Schema : projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-item-response
Type: object
Show Source
  • Title: All Day Exception Indicator
    Read Only: true
    Maximum Length: 1
    Default Value: true
    Indicates if the calendar exception is for the whole day.
  • Title: Calendar Exception Category Code
    Read Only: true
    Maximum Length: 30
    Category code in which the exception falls.
  • Title: Calendar Exception Code
    Read Only: true
    Maximum Length: 3
    Code to identify the exception.
  • Title: Calendar Exception Description
    Read Only: true
    Maximum Length: 2000
    Description of the exception.
  • 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.
  • Title: Calendar Exception ID
    Read Only: true
    Unique identifier of the exception in the calendar.
  • Links
  • Title: Calendar Exception Name
    Read Only: true
    Maximum Length: 240
    Name of the exception.
  • 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.
  • 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.
Back to Top