Get all technicians' access schedule
get
/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules
Request
Query Parameters
-
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- AccessScheduleByNumberFinder Find a technician's access schedule by the public unique identifier.
Finder Variables- AccScheduleNumber; string; The public unique identifier of the technician access schedule.
- PrimaryKey Find technician's access schedule by the specified access schedule unique identifier.
Finder Variables- AccScheduleId; integer; The unique identifier of the access schedule.
- byAccessScheduleFinder Find a technician's access schedule by the data provided.
Finder Variables- bindAccessScheduleId; integer; The unique identifier of the access schedule.
- bindAccessScheduleNumber; string; The public unique identifier of the technician access schedule.
- bindAccountPartyId; integer; The unique identifier of the account party for the access schedule.
- bindCountryCd; string; The country code for the access schedule.
- bindRegion; string; The region of country for the access schedule.
- bindServiceProfileId; integer; The unique identifier of the service profile for the access hours.
- bindWoId; integer; The unique identifier of the work order for the access hours.
- AccessScheduleByNumberFinder Find a technician's access schedule by the public unique identifier.
-
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:- AccScheduleId; integer; The unique identifier of the access schedule.
- AccScheduleNumber; string; The name of the access schedule.
- AccountPartyId; integer; The unique identifier for the account the technician's access schedule is for.
- AccountPartyName; string; The name of the account the technician's access schedule is for.
- AccountPartyNumber; string; The public unique identifier for the account the technician's access schedule is for.
- ActiveFlag; boolean; Indicates whether the technician's access schedule is active.
- Country; string; The country this technician's access schedule applies to.
- CountryCd; string; The code that identifies the country this technician access schedule applies to.
- CreatedBy; string; The user who created the access schedule.
- CreationDate; string; The date and time when the access schedule was created.
- Description; string; The description of the technician's access schedule.
- LastUpdateDate; string; The date and time when the access schedule was last updated.
- LastUpdatedBy; string; The user who last updated the access schedule.
- Name; string; The name of the technician access schedule.
- PrimaryFlag; boolean; Indicates if this is the primary access schedule.
- Region; string; The region of a country this access schedule applies to.
-
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 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 : serviceTechnicianAccessSchedules
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceTechnicianAccessSchedules-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier for the account the technician's access schedule is for. -
AccountPartyName: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the account the technician's access schedule is for. -
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The public unique identifier for the account the technician's access schedule is for. -
AccScheduleId: integer
(int64)
Title:
Access Schedule ID
The unique identifier of the access schedule. -
AccScheduleNumber: string
Title:
Schedule Number
Maximum Length:30
The name of the access schedule. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the technician's access schedule is active. -
Country: string
Title:
Country
Read Only:true
Maximum Length:80
The country this technician's access schedule applies to. -
CountryCd: string
Title:
Country Code
Maximum Length:2
The code that identifies the country this technician access schedule applies to. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the access schedule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the access schedule was created. -
Description: string
Title:
Description
Maximum Length:200
The description of the technician's access schedule. -
hours: array
Technician's Access Hours
Title:
Technician's Access Hours
The technician's access hours identifies the hours in which a technician can access a customer site. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the access schedule was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the access schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:50
The name of the technician access schedule. -
offdays: array
Technician's Access off Days
Title:
Technician's Access off Days
The technician's access off days identifies when a technician can't access a customer site. -
PrimaryFlag: boolean
Title:
Primary
Read Only:true
Maximum Length:1
Default Value:false
Indicates if this is the primary access schedule. -
Region: string
Title:
Region
Maximum Length:60
The region of a country this access schedule applies to.
Nested Schema : Technician's Access Hours
Type:
array
Title:
Technician's Access Hours
The technician's access hours identifies the hours in which a technician can access a customer site.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Technician's Access off Days
Type:
array
Title:
Technician's Access off Days
The technician's access off days identifies when a technician can't access a customer site.
Show Source
Nested Schema : serviceTechnicianAccessSchedules-hours-item-response
Type:
Show Source
object
-
AccScheduleId: integer
(int64)
Title:
Access Schedule ID
The unique identifier of the access schedule. -
AccScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:50
The name of the access schedule. -
AccScheduleNumber: string
Title:
Schedule Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the access schedule. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the technician's access hour is active. -
Comments: string
Title:
Comments
Maximum Length:250
The comments for the access hour. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the access hour. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the access hour was created. -
DayOfWeekCd: string
Title:
Day or Week Code
Maximum Length:30
The code that identifies the day of the week for the access hours. -
DayOfWeekCdMeaning: string
Title:
Day of Week
Read Only:true
Maximum Length:255
The day of the week for the access hours. -
DisplaySequence: string
Title:
Display Sequence
Read Only:true
Maximum Length:80
The display sequence for sorting by day. -
EndHourFirstSlot: string
Title:
End Hour Slot 1
Maximum Length:10
The end hour for the primary access hours. -
EndHourSecondSlot: string
Title:
End Hour Slot 2
Maximum Length:10
The end hour for the additional access hours. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the access hours were last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the access hours. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideCd: string
Title:
Override Code
Maximum Length:30
The code that identifies the type of override applied to the access hours. -
OverrideCdMeaning: string
Title:
Override
Read Only:true
Maximum Length:255
The type of override applied to the access hours. -
OverrideServiceProfileId: integer
(int64)
Title:
Override Service Profile ID
The unique identifier for the service profile that overrides the access hours. -
OverrideServiceProfileName: string
Title:
Service Profile
Read Only:true
Maximum Length:400
The name of the service profile that overrides the access hours. -
OverrideServiceProfileNumber: string
Title:
Service Profile Number
Read Only:true
Maximum Length:30
The public unique identifier of the service profile that overrides the access hours. -
OverrideWoId: integer
(int64)
Title:
Override Work Order ID
The unique identifier for the work order that overrides the access hours. -
OverrideWoNumber: string
Title:
Work Order Number
Read Only:true
Maximum Length:30
The public unique identifier of the work order that overrides the access hours. -
SchedHoursId: integer
(int64)
Title:
Schedule Hours ID
The unique identifier of the access hours. -
StartHourFirstSlot: string
Title:
Start Hour Slot 1
Maximum Length:10
The start hour of the primary access hours. -
StartHourSecondSlot: string
Title:
Start Hour Slot 2
Maximum Length:10
The start hour of the additional access hours.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : serviceTechnicianAccessSchedules-offdays-item-response
Type:
Show Source
object
-
AccScheduleId: integer
(int64)
Title:
Access Schedule ID
The unique identifier of the access schedule. -
AccScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:50
The name of the access schedule. -
AccScheduleNumber: string
Title:
Schedule Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the access schedule. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether this technician access off days is active. -
Comments: string
Title:
Comments
Maximum Length:60
Comments for the access off day. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the technician's access off day. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the technician's access off day was created. -
DayOfWeekCd: string
Title:
Day of Week Code
Maximum Length:30
The code that identifies the day of the week for the access off day. -
DayOfWeekCdMeaning: string
Title:
Day of Week
Read Only:true
Maximum Length:255
The day of the week for the technician's access off day. -
DayOfWeekOccurrenceCd: string
Title:
Monthly Occurrence Code
Maximum Length:30
The code that identifies the occurrence to calculate date by in a month for the access off day. -
DayOfWeekOccurrenceCdMeaning: string
Title:
Monthly Occurrence
Read Only:true
Maximum Length:255
The occurrence to calculate date of a month for the access off day. -
Label: string
Title:
Name
Maximum Length:60
The label for the off day. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the technician's access off day was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the technician's access off day. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OffDate: string
(date)
Title:
Date
Read Only:true
The calculated off date. -
OffDay: integer
(int32)
Title:
Day
The day of the month on which the field service resource isn't allowed to be on the customer site. -
OffMonthCd: string
Title:
Month Code
Maximum Length:30
The digits representing month of the year the field service resource isn't allowed to be on the customer site. -
OffMonthCdMeaning: string
Title:
Month
Read Only:true
Maximum Length:255
The name of the month the field service resource isn't allowed to be on the customer site. -
OffYear: integer
(int32)
Title:
Year
The four digit year the field service resource isn't allowed to be on the customer site. -
OverrideCd: string
Title:
Override Code
Maximum Length:30
The code that identifies the type of override applied to the technician's access off day. -
OverrideCdMeaning: string
Title:
Override
Read Only:true
Maximum Length:255
The type of override applied to the technician's access off day. -
OverrideServiceProfileId: integer
(int64)
Title:
Service Profile ID
The unique identifier for the service profile that overrides the technician's access off day. -
OverrideServiceProfileName: string
Title:
Service Profile
Read Only:true
Maximum Length:400
The name of the service profile that overrides the technician's access off day. -
OverrideServiceProfileNumber: string
Title:
Service Profile Number
Read Only:true
Maximum Length:30
The public unique identifier of the service profile that overrides the technician's access off day. -
OverrideWoId: integer
(int64)
Title:
Work Order ID
The unique identifier for the work order that overrides the technician's access off day. -
OverrideWoNumber: string
Title:
Work Order Number
Read Only:true
Maximum Length:30
The public unique identifier of the work order that overrides the technician's access off day. -
SchedOffdaysId: integer
(int64)
Title:
Schedule off Day ID
The unique identifier of the technician's access off day.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- getAccessScheduleHoursPayload
-
The method gets the access schedule hours payload in JSON format for use when calling Field Service REST services to query for scheduler data.
- getAccessScheduleOffdaysPayload
-
The method gets the access schedule days payload in JSON format for use when calling Field Service REST services to query for scheduler data.
- getAccessSchedulePayload
-
Operation: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/action/getAccessSchedulePayloadThe method gets the access schedule payload in JSON format for use when calling Field Service REST services to query for scheduler data.
Examples
You can get all technicians' access schedule by submitting a GET request on the REST resource using the following cURL
cURL Command
curl -u <username:password> \ -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules
Example of Response Body
The following shows the contents of the Response Body in JSON format.
{ "items": [ { "AccScheduleId": 100103879969184, "AccScheduleNumber": "CDRM_0", "Name": "Primary Technician Access Schedule", "Description": "Primary Technician Access Schedule", "PrimaryFlag": true, "AccountPartyId": null, "AccountPartyName": null, "AccountPartyNumber": null, "CountryCd": null, "Country": null, "Region": null, "ActiveFlag": false, "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2024-03-01T08:31:52.741+00:00", "LastUpdateDate": "2024-03-20T01:42:59.492+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_0", "name": "serviceTechnicianAccessSchedules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_0", "name": "serviceTechnicianAccessSchedules", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_0/child/hours", "name": "hours", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_0/child/offdays", "name": "offdays", "kind": "collection" } ] }, { "AccScheduleId": 300100283975427, "AccScheduleNumber": "CDRM_1", "Name": "FSACCOUNT Schedule", "Description": "FSACCOUNT Schedule", "PrimaryFlag": false, "AccountPartyId": 300100126721679, "AccountPartyName": "FSACCOUNT", "AccountPartyNumber": "CDRM_721531", "CountryCd": null, "Country": null, "Region": null, "ActiveFlag": true, "CreatedBy": "MHoope", "CreationDate": "2024-03-26T05:16:16+00:00", "LastUpdateDate": "2024-03-26T05:16:16.190+00:00", "LastUpdatedBy": "MHoope", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_1", "name": "serviceTechnicianAccessSchedules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_1", "name": "serviceTechnicianAccessSchedules", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_1/child/hours", "name": "hours", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/CDRM_1/child/offdays", "name": "offdays", "kind": "collection" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules", "name": "serviceTechnicianAccessSchedules", "kind": "collection" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/action/getAccessSchedulePayload", "name": "getAccessSchedulePayload", "kind": "other" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/action/getAccessScheduleHoursPayload", "name": "getAccessScheduleHoursPayload", "kind": "other" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/action/getAccessScheduleOffdaysPayload", "name": "getAccessScheduleOffdaysPayload", "kind": "other" } ] }