Get a scheduler
get
/crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}
Request
Path Parameters
-
SchedulerCd(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 TopResponse
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.
Root Schema : fieldServiceSchedulers-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates whether the scheduler is active. -
AssignedRoleDisp: string
Title:
Roles
Read Only:true
A comma delimited list of roles assigned to the scheduler. -
ConnectionCd: string
Title:
Connection Code
Maximum Length:30
Value that uniquely identifies the field service connection associated to this scheduler. -
ConnnectionName: string
Title:
Connection Name
Read Only:true
Maximum Length:80
The user defined name for the field service connection associated to this scheduler. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the scheduler. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of creating the scheduler. -
CurrentDayBuffer: integer
(int64)
Title:
Current Day Buffer
The buffer in minutes for the scheduler current day. -
Description: string
Title:
Description
Maximum Length:240
The description for the scheduler. -
EnforcePreferredTechFlag: boolean
Title:
Enable Preferred Technician
Maximum Length:1
Default Value:false
Indicates whether the preferred technician tags should be enforced on the scheduler. -
HighQuotaCutoff: integer
(int64)
Title:
High Quota Cutoff
The cutoff for high quota. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time of last update for the scheduler. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the scheduler. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LowQuotaCutoff: integer
(int64)
Title:
Low Quota Cutoff
The cutoff for low quota. -
SchedulerCd: string
Title:
Scheduler Code
Maximum Length:30
Value that uniquely identifies the alternate unique identifier for the scheduler. -
schedulerFilters: array
Scheduler Filters
Title:
Scheduler Filters
Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time. -
SchedulerId: integer
(int64)
Title:
Scheduler ID
Read Only:true
The unique identifier of the scheduler. -
SchedulerName: string
Title:
Scheduler Name
Maximum Length:80
The user defined name for the scheduler. -
SchedulerOrder: integer
(int64)
Title:
Order
The order of the scheduler. -
schedulerRoles: array
Scheduler Roles
Title:
Scheduler Roles
Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order. -
SchedulerTypeCd: string
Title:
Scheduler Type
Maximum Length:30
The code that identifies the type of scheduler. -
SchedulerTypeDisp: string
Title:
Scheduler Type
Read Only:true
Maximum Length:80
The name of the scheduler type selected for this scheduler. -
translations: array
Scheduler Translations
Title:
Scheduler Translations
Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler. -
WeekStartDayCd: string
Title:
Scheduler Start of Week
Maximum Length:30
The code that identifies the week start day used for the scheduler. -
WeekStartDayMeaning: string
Title:
Scheduler Start of Week
Read Only:true
Maximum Length:255
The start day of the week used for the scheduler.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scheduler Filters
Type:
array
Title:
Scheduler Filters
Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.
Show Source
Nested Schema : Scheduler Roles
Type:
array
Title:
Scheduler Roles
Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.
Show Source
Nested Schema : Scheduler Translations
Type:
array
Title:
Scheduler Translations
Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : fieldServiceSchedulers-schedulerFilters-item-response
Type:
Show Source
object
-
AllowReleaseFlag: boolean
Title:
Allow Agent to Release Filter
Maximum Length:1
Indicates whether the agent can release the filter when viewing the scheduler results. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the scheduler filter. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of creating the scheduler filter. -
FilterOrder: integer
(int64)
Title:
Filter Order
Identifies the order of this scheduler filter that needs to be applied. -
FsResourceField: string
Title:
Field Service Resource
Maximum Length:64
The field service resource from Oracle Field Service. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the scheduler was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the scheduler filter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SchedulerCd: string
Title:
Scheduler Code
Maximum Length:30
Value that uniquely identifies the scheduler. -
SchedulerFilterCd: string
Title:
Scheduler Filter Code
Maximum Length:30
Value that uniquely identifies the filter associated to the scheduler. -
SchedulerFilterId: integer
(int64)
Title:
Scheduler Filter ID
Read Only:true
The unique identifier of the scheduler filter. -
WoField: string
Title:
Filter Field Name
Maximum Length:30
The filter type for this filter. -
WoFieldLabel: string
Title:
Field Label
Read Only:true
The work order field label on which the filter is to be applied. -
WoFieldType: string
Title:
Field Type
Maximum Length:64
The work order field type on which the filter is to be applied. -
WoFieldValue: string
Title:
Field Value
Maximum Length:64
The work order field value on which the filter is to be applied.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fieldServiceSchedulers-schedulerRoles-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the scheduler role. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of creating the scheduler role. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The description for the role. -
JobRole: string
Title:
Job Role
Read Only:true
Maximum Length:30
The name of job role. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the scheduler role was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the scheduler role. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleCommonName: string
Title:
Role Common Name
Maximum Length:4000
The role common name defined within LDAP. -
RoleGUID: string
Title:
Role GUID
Maximum Length:64
The unique identifier of the role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:240
The name of the role being used for this scheduler. -
SchedulerCd: string
Title:
Scheduler Code
Maximum Length:30
Value that uniquely identifies the scheduler. -
SchedulerRoleId: integer
(int64)
Title:
Scheduler Role ID
Read Only:true
The unique identifier of the scheduler role.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fieldServiceSchedulers-translations-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
The description for the scheduler. -
DisplayLanguage: string
Title:
Language Name
Read Only:true
Maximum Length:255
The language to which the scheduler is translated. -
DisplaySourceLanguage: string
Title:
Source Language
Read Only:true
Maximum Length:255
The source language from which the scheduler is translated. -
Language: string
Title:
Language
Maximum Length:4
The warning message to display when an agent selects a time slot on a holiday. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SchedulerName: string
Title:
Scheduler Name
Maximum Length:80
The name for the scheduler. -
SourceLang: string
Title:
Source Language
Maximum Length:4
The source language code from which the scheduler is translated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- schedulerFilters
-
Operation: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFiltersParameters:
- SchedulerCd:
$request.path.SchedulerCd
Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time. - SchedulerCd:
- schedulerRoles
-
Operation: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerRolesParameters:
- SchedulerCd:
$request.path.SchedulerCd
Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order. - SchedulerCd:
- translations
-
Operation: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translationsParameters:
- SchedulerCd:
$request.path.SchedulerCd
Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler. - SchedulerCd: