Jump to

• Request
• Response

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

• projectEnterpriseLaborResourcesUniqID(required): string
  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

• 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
• finder: string
  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.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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.
• totalResults: boolean
  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

• 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 : projectEnterpriseLaborResources-ResourceCalendars

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object projectEnterpriseLaborResources-ResourceCalendars-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-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 : projectEnterpriseLaborResources-ResourceCalendars-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Indicator

  Read Only: true

  Indicates if the calendar is active.
• CalendarExceptions: array 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.
• CalendarId: integer (int64)
  Title: Calendar ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 30

  The category used for the calendar.
• 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 from which the calendar is 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 are workable. True if it's workable, False if it's not.
• HoursPerDay: number
  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: 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.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the calendar.
• QuaterlyTypeCode: string
  Title: Quarterly Type Code

  Read Only: true

  Maximum Length: 30

  Indicates the quarter type of 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 used for the calendar.",
            "nullable":true,
            "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
        },
        "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 of 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 working hours in a day. Value depends on the number of hours in 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":"Project Enterprise Resource Calendar Exceptions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-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
        },
        "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
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveFromDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the calendar is effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FridayWorkFlag":{
            "title":"Friday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Fridays are workable. True if it's workable, False if it's 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
        },
        "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 : 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

• Array of: object projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-item-response

{
    "title":"Project Enterprise Resource Calendar Exceptions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-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 : projectEnterpriseLaborResources-ResourceCalendars-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."
        }
    }
}

Back to Top