1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. List of Values
  4. Availability Resource

Get all matched resources

get

/crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources

Request

Query Parameters
  • 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

    • FindByAll Finds the available resources for direct assignment as well as applying technician preference and access schedules.
      Finder Variables
      • applyTechnicianPreferenceInSummary; boolean; Indicates whether to apply technician preference when requesting summary information.
      • byAccessScheduleNumber; string; The public unique identifier of the technician access schedule.
      • byAccountPartyId; integer; The unique identifier of the account party for the access schedule.
      • byCountryCd; string; The country code for the access schedule.
      • byRegion; string; The region for the access schedule.
      • byScheduleDaysToReturn; integer; The number of schedule days to return for the access schedule.
      • byServiceProfileId; integer; The unique identifier of the service profile to retrieve the access schedule.
      • byWoId; integer; The unique identifier of the work order for the access schedule.
      • endDate; string; The end date for the availability.
      • fsTypeCd; string; The unique code for the activity type.
      • startDate; string; The start date for the availability.
      • timeZone; string; The time zone associated with the availability of the resource.
      • viewSummaryFlag; boolean; Indicates whether to show summary or detail data. The default value is false which means it will show the detail view.
      • woAreaKey; string; The key for the work order area.
    • PrimaryKey Finds the matched resource with the specified primary key.
      Finder Variables
      • ResourceId; integer; The unique identifier for the resource.
    • WoDirectAssignmentFinder Finds matching resources for direct assignment using the work order area key, activity type code, time zone, and start date.
      Finder Variables
      • endDate; string; The end date for the availability.
      • fsTypeCd; string; The unique code for the activity type.
      • startDate; string; The start date for the availability.
      • timeZone; string; The time zone associated with the availability of the resource.
      • viewSummaryFlag; boolean; Indicates whether to show summary or detail data. The default value is false which means it will show the detail view.
      • woAreaKey; string; The key for the work order area.
  • 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:
    • AccessScheduleName; string; The name for the access schedule.
    • AccessScheduleNumber; string; The public unique identifier of the technician access schedule.
    • AccessSchedulePayload; string; The payload for the access schedule.
    • AccountPartyId; integer; The unique identifier of the account party for the access schedule.
    • AllowReleaseAccessScheduleFlag; boolean; Indicates if access schedules filter can be released.
    • AllowReleaseTechnicianPreferenceFlag; boolean; Indicates if technician preference filter can be released.
    • ApplyFilterTechnicianPreferenceFlag; boolean; Indicates if technician preference filter is used.
    • ApplyTechnicianPreferenceInSummaryFlag; boolean; Indicates whether to apply technician preference when requesting summary information.
    • CountryCd; string; The country code for the access schedule.
    • EndDate; string; The end date for the available resource.
    • FsTypeCd; string; The unique code of the activity type.
    • Region; string; The region for the access schedule.
    • ResourceExternalId; string; The external unique identifier for the available resource.
    • ResourceId; integer; The unique identifier for the available resource.
    • ResourceName; string; The name of the available resource.
    • ScheduleDaysToReturn; integer; The number of schedule days to return for the access schedule.
    • ServiceProfileId; integer; The unique identifier of the service profile to retrieve the access schedule.
    • StartDate; string; The start date for the available resource.
    • TechnicianPreference; string; The preference type for the technician.
    • TechnicianPreferenceCd; string; The code that identifies the preference type for this technician.
    • TimeZone; string; The time zone associated with the available resource.
    • ViewSummaryFlag; boolean; Indicates whether to show summary or detail data. The default value is false which means it will show the detail view.
    • WoAreaKey; string; The work order area key associated with the available resource.
    • WoId; integer; The unique identifier of the work order for the access schedule.
  • 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 : svcWoDAAvailableResources
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : svcWoDAAvailableResources-item-response
Type: object
Show Source
Nested Schema : Availability
Type: array
Title: Availability
The Availability resource lets you view availability for resources from Oracle Field Service.
Show Source
Nested Schema : Time Slots
Type: array
Title: Time Slots
The time slot resource lets you view all times slots used in Oracle Field Service.
Show Source
Nested Schema : svcWoDAAvailableResources-Availability-item-response
Type: object
Show Source
Nested Schema : svcWoDAAvailableResources-TimeSlotInfo-item-response
Type: object
Show Source
Back to Top