Jump to

• Request
• Response
• Examples

Get a resource route

get

/rest/ofscCore/v1/resources/{resourceId}/routes/{date}

This operation retrieves a list of activities assigned to the specified resource for the specified date.

Special values can be specified in the date field to return a list of activities not scheduled for a specific date or to return a list of segmentable activities assigned to the resource.

Request

Supported Media Types

• application/x-www-form-urlencoded

Path Parameters

• date(required): string
  The date of the route. The date can have the following values:

  • The date in YYYY-MM-DD format.
  • Special value 'nonScheduled' to return activities without a specific date.
  • Special value 'multiday' to return segmentable activities.
• resourceId(required): string
  The unique identifier of the resource.

Query Parameters

• activityFields: array[string]
  Collection Format: csv

  The comma-separated names of the activity fields (properties) returned in the response. The available fields are same as those present in the 'get activity' method except for the file properties. The start time and time zone information is returned when the parameter is ignored.
• limit: integer
  The number of items to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
• offset: integer
  The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Route

Type: object

Title: Route

The route of the specified resource.

Show Source

• date: string
  Title: Date

  The specified date of the route.
• items: array Items
  Title: Items

  The list of activity fields.
• limit: integer
  Title: Limit

  The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.
• offset: integer
  Title: Offset

  The offset value specified in the request.
• resourceId: string
  Title: Resource ID

  The resource ID specified in the request.
• routeEndTime: string
  Title: Route End Time

  The end time of the route.
• routeReactivationTime: string
  Title: Route Reactivation Time

  The reactivation time of the route.
• routeStartTime: string
  Title: Route Start Time

  The start time of the route.
• totalResults: integer
  Title: Total Results

  The total number of activities in the response.

{
    "properties":{
        "routeReactivationTime":{
            "type":"string",
            "description":"The reactivation time of the route.",
            "title":"Route Reactivation Time"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/activity"
            },
            "type":"array",
            "description":"The list of activity fields.",
            "title":"Items"
        },
        "routeStartTime":{
            "type":"string",
            "description":"The start time of the route.",
            "title":"Route Start Time"
        },
        "routeEndTime":{
            "type":"string",
            "description":"The end time of the route.",
            "title":"Route End Time"
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of activities in the response.",
            "title":"Total Results"
        },
        "resourceId":{
            "type":"string",
            "description":"The resource ID specified in the request.",
            "title":"Resource ID"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request.",
            "title":"Offset"
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.",
            "title":"Limit"
        },
        "date":{
            "type":"string",
            "description":"The specified date of the route.",
            "title":"Date"
        }
    },
    "description":"The route of the specified resource.",
    "type":"object",
    "title":"Route"
}

Nested Schema : Items

Type: array

Title: Items

The list of activity fields.

Show Source

• Array of: object Activity Properties
  Title: Activity Properties

  The array of activity property objects.

{
    "items":{
        "$ref":"#/definitions/activity"
    },
    "type":"array",
    "description":"The list of activity fields.",
    "title":"Items"
}

Nested Schema : Activity Properties

Type: object

Title: Activity Properties

The array of activity property objects.

Show Source

• accessSchedule: string
  Title: Access Schedule

  The schedule (that is, the set of time intervals or access hours, two intervals per week day) when the asset or the activity location is accessible. Work must start and complete during this interval. It is generally not possible to work beyond the access hours. Maximum field length is 1020.

  Access Schedule Field Format
  This field is a string, which contains an inner json object (encoded as a string). For example, "accessSchedule": "{\"schedule\":[{\"daysOfWeek\":[\"Mon\",\"Tue\"],\"hours\":[[\"07:00\",\"12:00\"]]}]}"

  The inner json object has the following schema:

  {
  "type": "object",
  "properties": {
  "schedule": {
  "type": "array",
  "items": {
  "type": "object",
  "properties": {
  "daysOfWeek": {
  "type": "array",
  "items": {
  "type": "string",
  "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ]
  }
  },
  "hours": {
  "type": "array",
  "items": {
  "type": "array",
  "items": { "type": "string" }
  }
  }
  }
  }
  },
  "exceptDates": {
  "type": "array",
  "items": { "type": "string" }
  }
  }
  }

• activityFlow: string
  Title: Activity Flow

  Activity flow label
• activityId: integer
  Title: Activity ID

  The unique identifier of the activity.
• activityType: string
  Title: Activity Type

  The label of the activity type. Based on the activity type, predefined company-specific rules are applied while processing an activity. Predefined company-specific rules cover the following:

  • The resources to which the activity is assigned.
  • The activity processing details.
  • The interaction of the activity with different modules of Oracle Field Service.
• apptNumber: string
  Title: Appointment Number

  This field may be used by integrations to store the identifier of the activity in the origin system. This field has no business significance in Oracle Field Service and can be left empty. Maximum field length is 40.
• autoRoutedToDate: string
  Title: Auto Routed To Date

  The date to which the activity was moved automatically by routing. Rescheduling the activity does not change this value. It is a read-only field.
• autoRoutedToResource: string
  Title: Auto Routed To Resource

  The external ID of resource to which the activity was last assigned by routing. Reassigning the activity does not change this value. It is a read-only field. If the field has no value, it means that the routing assigned the activity to a resource with empty external ID.
• city: string
  Title: City

  The city of the customer where the activity is scheduled. Maximum field length is 60. If a longer value is sent it will be truncated.
• coordinateAccuracy: string
  Title: Coordinate Accuracy

  The coordinate accuracy of the activity. It is a read-only field. The following values are returned:

  • Low
  • Medium
  • High

• country_code: string
  Title: Country Code

  The code of the country where the activity is scheduled.
• customerCell: string
  Title: Customer Cell

  The cell phone number of the customer. From version 17.2.1, the phone number is saved with the '+' symbol. For example, if you enter the phone number as [phone]_42, it is saved as [phone]. In versions before 17.2.1, the phone number is saved as 12342342342. Maximum field length is 240. If a longer value is sent it will be truncated.
• customerEmail: string
  Title: Customer Email

  The email address of the customer. Maximum field length is 320. If a longer value is sent it will be truncated.
• customerName: string
  Title: Customer Name

  The name of the customer. Maximum field length is 420. If a longer value is sent it will be truncated.
• customerNumber: string
  Title: Customer Number

  The account number of the customer. This field is used by integrations as a placeholder for the external identifier of the Account ID in the application. This parameter has no business significance in Oracle Field Service and can be left empty. Maximum field length is 40. If a longer value is sent it will be truncated.
• customerPhone: string
  Title: Customer Phone

  The regular (land) phone number of the customer. From version 17.2.1, the phone number is saved in Oracle Field Service with the '+' symbol. For example, if you enter the phone number as [phone]_42, it is saved in Oracle Field Service as [phone]. In versions before 17.2.1, the phone number is saved as 12342342342. Maximum field length is 240. If a longer value is sent it will be truncated.
• date: string
  Title: Date

  The date on which the activity is scheduled. This field is not present in the response, if the activity is not scheduled for any particular date.
• deliveryWindowEnd: string
  Title: Delivery Window End

  The time when the activity delivery window ends. The time is displayed in the time zone of the resource to which the activity is assigned and is in HH:MM:SS format.
• deliveryWindowStart: string
  Title: Delivery Window Start

  The time when the activity delivery window starts. The time is displayed in the time zone of the resource to which the activity is assigned and is in HH:MM:SS format.
• duration: integer
  Title: Duration

  The estimated duration of the activity in minutes.
• endTime: string
  Title: End Time

  The predicted or the actual end time of the activity. The time is displayed in the time zone of the resource to which the activity is assigned and is in YYYY-MM-DD HH:MM:SS format.
• firstManualOperation: string
  Title: First Manual Operation

  The name of the first manual operation on the activity.
• firstManualOperationUser: string
  Title: First Manual Operation User

  The user who performed the first manual operation on the activity.
• ibAssetId: integer
  Title: ibAsset Id

  The identifier of the installed based asset the activity is linked to. Optional field. Foreign key to CSE_ASSETS_B.ASSET_ID in Fusion.
• language: string
  Title: Language

  The preferred language of the customer. This parameter returns two-character code (e.g. "en") in API responses. To obtain ISO code of the language (e.g. "en-US") read the "languageISO" parameter. In the requests this parameter accepts both formats (e.g. "en" or "en-US"). It is recommended to use ISO format. The language codes listed on: Supported Language Codes.
• languageISO: string
  Title: Language ISO

  The preferred language of the customer. This parameter is only present in the responses and will be ignored if it is present in a request. To update language use the parameter "language". The language codes listed on: Supported Language Codes.
• latitude: number
  Title: Latitude

  Minimum Value: -90

  Maximum Value: 90

  The geographic latitude coordinate that specifies the location of the activity.
• longitude: number
  Title: Longitude

  Minimum Value: -180

  Maximum Value: 180

  The geographic longitude coordinate that specifies the location of the activity.
• masterActivityId: integer
  Title: Master Activity ID

  The identifier of a segmentable activity. It is available for individual segments which have the record type set to 'multiday_activity_segment'. This field is not set for regular activities.
• pjfProjectElementId: integer
  Title: pjfProject Element Id

  The identifier of the project task the activity is linked to. Optional field. Foreign key to PJF_PROJ_ELEMENTS_B.PROJ_ELEMENT_ID in Fusion.
• pjfProjectId: integer
  Title: pjfProject Id

  The identifier of the project the activity is linked to. Optional field. Foreign key to PJF_PROJECTS_ALL_B.PROJECT_ID in Fusion.
• points: integer
  Title: Points

  Minimum Value: 0

  Maximum Value: 65535

  The cost of the activity in 'points'. This field is intended for use by the Routing module.
• positionInRoute: integer
  Title: Position In Route

  The position of the activity in the route. For not-ordered activities, this field is not present in the response. For ordered activities, a 1-based number is returned.
• postalCode: string
  Title: Postal Code

  The postal code of the customer. This field is used for geocoding and must contain a valid address. Maximum field length is 60. If a longer value is sent it will be truncated.
• recordType: string
  Title: Record Type

  Allowed Values: [ "regular", "reopened", "prework", "multiday_activity", "multiday_activity_segment" ]

  The type of the activity record. The following values are allowed:

  • regular: This is the default record type for most new activities.
  • prework: This type of record is created if a technician has to perform some work before the actual activity starts.
  • reopened: A record of this type is created when an activity is reopened for some reason.
  • multiday_activity: This record type is created when the 'activityType' indicates that it is a segmentable activity.
  • multiday_activity_segment: A number of records of this type are created for segmentable activities, based on their duration and time slot settings.
• reminderTime: integer
  Title: Reminder Time

  The number of minutes before the activity start time when the customer must be notified of the activity.
• resourceId: string
  Title: Resource ID

  The identifier of the resource to which this activity is assigned. This field is not returned if the resource ID is empty.

  Note: Do not use empty strings in requests.

• resourceTimeZone: string
  Title: Resource Time Zone

  The time zone of the resource to which this activity is assigned (for example, Eastern). This is a read-only field and may change when the activity is reassigned to another resource.
• resourceTimeZoneDiff: integer
  Title: Resource Time Zone Difference

  The difference between UTC and the resource's local time, displayed in minutes. For example, -180 means that the resource time is 3 hours behind UTC. This field is read-only and may change when the activity is reassigned to another resource.
• resourceTimeZoneIANA: string
  Title: Resource Time Zone IANA Name

  The IANA name of the resource's time zone (for example, America/New_York). This field is read-only and may change when the activity is reassigned to another resource.
• serviceWindowEnd: string
  Title: Service Window End

  The time when the service window ends for the activity. The time is displayed in 'HH:MM:SS' format.

  Service window is returned in the time zone of the resource to which the activity is currently assigned.

• serviceWindowStart: string
  Title: Service Window Start

  The time when the service window starts for the activity. The time is displayed in 'HH:MM:SS' format.

  Service window is returned in the time zone of the resource to which the activity is currently assigned.

• slaWindowEnd: string
  Title: Sla Window End

  The time when the service level agreement (SLA) window ends. The time is displayed in 'YYYY-MM-DD HH:MM:SS' format.

  SLA window is returned in the time zone of the resource to which the activity is currently assigned.

• slaWindowStart: string
  Title: Sla Window Start

  The time when the service level agreement (SLA) window starts. The time is displayed in 'YYYY-MM-DD HH:MM:SS' format.

  SLA window is returned in the time zone of the resource to which the activity is currently assigned.

• startTime: string
  Title: Start Time

  The estimated time of arrival for the activities in 'pending' status and the actual start time for the activities in 'started' and 'completed' status. The time is displayed in 'YYYY-MM-DD HH:MM:SS' format in the time zone of the resource to which the activity is assigned.
• stateProvince: string
  Title: State Province

  The state or province of the customer. This field is used for geocoding and must contain a valid address. Maximum field length is 60. If a longer value is sent it will be truncated.
• status: string
  Title: Status

  Allowed Values: [ "cancelled", "completed", "suspended", "started", "enroute", "pending", "notdone" ]

  The status of the activity. As a technician works through the activity, the status changes. The actions that are available for an activity are based on this status.

  A newly created activity has the status as 'pending', but it can then be changed to 'cancelled' or 'started'. The status of an activity can be changed to 'complete', 'notdone', or 'suspended' only if it has the status as 'started'.

• streetAddress: string
  Title: Street Address

  The street address of the customer. This field is used for geocoding and must contain a valid address. Maximum field length is 240. If a longer value is sent it will be truncated.
• svcWorkOrderId: integer
  Title: svcWorkOrder Id

  The identifier of the fusion service work order the activity is linked to. Optional field. Foreign key to SVC_WORK_ORDERS.WO_ID in Fusion.
• teamResourceId: string
  Title: Team Resource ID

  The identifier of the team resource for a teamwork activity.
• timeDeliveredEnd: string
  Title: Time Delivered End

  The end time of the technician's arrival interval as communicated to the customer. The value is used by routing optimization engine to reduce changes to arrival time, so it is important to keep the value actual. This time is displayed in 'YYYY-MM-DD HH:MM:SS' format in the time zone of the resource to which the activity is assigned.
• timeDeliveredStart: string
  Title: Time Delivered Start

  The start time of the technician's arrival interval as communicated to the customer. The value is used by routing optimization engine to reduce changes to arrival time, so it is important to keep the value actual. This time is displayed in 'YYYY-MM-DD HH:MM:SS' format in the time zone of the resource to which the activity is assigned.
• timeOfAssignment: string
  Title: Time Of Assignment

  The time when the activity is assigned to the technician. This time is displayed in the time zone of the resource to which the activity is assigned.
• timeOfBooking: string
  Title: Time Of Booking

  The time when the customer booked the activity. The time is displayed in the time zone of the customer.
• timeSlot: string
  Title: Time Slot

  The time slot during which the activity is completed. The time slot also indicates the service window for the activity.
• timeZone: string
  Title: Time Zone

  The name of the customer's time zone. For example, Eastern.

  By default, the time zone of the resource to which the activity is assigned is used.

  For a list of supported time zones, see Supported Time Zones.

• timeZoneIANA: string
  Title: Time Zone IANA name

  The IANA name of the time zone. For more information, visit https://www.iana.org/time-zones. For example, America/New_York. This field is read-only, but when creating or updating an activity, the field 'timeZone' accepts both IANA names and Oracle Field Service specific names.
• travelEstimationMethod: string
  Title: Travel Estimation Method

  The travel estimation method. It is a read-only field. The following values are returned:

  • Airline Distance
  • Airline Distance and Statistics
  • External Adjustment
  • Manual Adjustment
  • Not Estimated
  • Point to Point
  • Same Location
  • Statistics
  • Street Level Routing
  • Travel key based Airline Distance
  • Using Defaults

• travelTime: integer
  Title: Travel Time

  Read Only: true

  The estimated time taken to travel to this activity. For activities that were started (status is 'started', 'completed', 'notdone') this parameter indicates reported travelling time, which is calculated based on the actual times.

  Notice that reported travelling time keeps the paid part of the travelling time and may be different from the value shown in UI, depending on the "Travel Allowance" configuration of resource type.

  (Exception : the "activityChanges" object of activity events always brings the full value of the travelling time).

• wieWorkOrderId: integer
  Title: wieWorkOrder Id

  The identifier of the maintenance work order the activity is linked to. Optional field. Foreign key to WIE_WORK_ORDERS_B.WORK_ORDER_ID in Fusion.
• wieWorkOrderOperationId: integer
  Title: wieWorkOrderOperation Id

  The identifier of the maintenance work order operation the activity is linked to. Optional field. Foreign key to WIE_WO_OPERATIONS_B.WO_OPERATION_ID in Fusion.
• workZone: string
  Title: Work Zone

  The work zone in which the activity occurs. It is a read-only field that is automatically assigned to an activity, based on the company setting 'work zone key' and the activity properties. For example, if 'work zone key' is the first 4 symbols of the 'city' field, then the activity with city=Belfast will have a work zone assigned which has 'BELF' as one of its keys.

{
    "properties":{
        "customerEmail":{
            "type":"string",
            "description":"The email address of the customer. Maximum field length is 320. If a longer value is sent it will be truncated.",
            "title":"Customer Email"
        },
        "accessSchedule":{
            "$ref":"#/definitions/activityAccessSchedule"
        },
        "timeZone":{
            "type":"string",
            "description":"The name of the customer's time zone. For example, Eastern. <p>By default, the time zone of the resource to which the activity is assigned is used.<p>For a list of supported time zones, see <a href=\"OFSC_Supported_Time_Zones.html\">Supported Time Zones</a>.</p>",
            "title":"Time Zone"
        },
        "timeZoneIANA":{
            "type":"string",
            "title":"Time Zone IANA name",
            "description":"The IANA name of the time zone. For more information, visit https://www.iana.org/time-zones. For example, America/New_York. This field is read-only, but when creating or updating an activity, the field 'timeZone' accepts both IANA names and Oracle Field Service specific names."
        },
        "resourceTimeZone":{
            "type":"string",
            "title":"Resource Time Zone",
            "description":"The time zone of the resource to which this activity is assigned (for example, Eastern). This is a read-only field and may change when the activity is reassigned to another resource."
        },
        "resourceTimeZoneIANA":{
            "type":"string",
            "title":"Resource Time Zone IANA Name",
            "description":"The IANA name of the resource's time zone (for example, America/New_York). This field is read-only and may change when the activity is reassigned to another resource."
        },
        "resourceTimeZoneDiff":{
            "type":"integer",
            "title":"Resource Time Zone Difference",
            "description":"The difference between UTC and the resource's local time, displayed in minutes. For example, -180 means that the resource time is 3 hours behind UTC. This field is read-only and may change when the activity is reassigned to another resource."
        },
        "date":{
            "type":"string",
            "description":"The date on which the activity is scheduled. This field is not present in the response, if the activity is not scheduled for any particular date.",
            "title":"Date"
        },
        "serviceWindowStart":{
            "$ref":"#/definitions/serviceWindowStartOutput"
        },
        "serviceWindowEnd":{
            "$ref":"#/definitions/serviceWindowEndOutput"
        },
        "slaWindowStart":{
            "$ref":"#/definitions/slaWindowStartOutput"
        },
        "slaWindowEnd":{
            "$ref":"#/definitions/slaWindowEndOutput"
        },
        "startTime":{
            "type":"string",
            "description":"The estimated time of arrival for the activities in 'pending' status and the actual start time for the activities in 'started' and 'completed' status. The time is displayed in 'YYYY-MM-DD HH:MM:SS' format in the time zone of the resource to which the activity is assigned.",
            "title":"Start Time"
        },
        "endTime":{
            "type":"string",
            "description":"The predicted or the actual end time of the activity. The time is displayed in the time zone of the resource to which the activity is assigned and is in YYYY-MM-DD HH:MM:SS format.",
            "title":"End Time"
        },
        "firstManualOperation":{
            "type":"string",
            "description":"The name of the first manual operation on the activity.",
            "title":"First Manual Operation"
        },
        "teamResourceId":{
            "type":"string",
            "description":"The identifier of the team resource for a teamwork activity.",
            "title":"Team Resource ID"
        },
        "workZone":{
            "type":"string",
            "description":"The work zone in which the activity occurs. It is a read-only field that is automatically assigned to an activity, based on the company setting 'work zone key' and the activity properties. For example, if 'work zone key' is the first 4 symbols of the 'city' field, then the activity with city=Belfast will have a work zone assigned which has 'BELF' as one of its keys.",
            "title":"Work Zone"
        },
        "travelTime":{
            "type":"integer",
            "readOnly":true,
            "description":"<p>The estimated time taken to travel to this activity. For activities that were started (status is 'started', 'completed', 'notdone') this parameter indicates reported travelling time, which is calculated based on the actual times.</p><p>Notice that reported travelling time keeps the paid part of the travelling time and may be different from the value shown in UI, depending on the \"Travel Allowance\" configuration of resource type.</p><p>(Exception : the \"activityChanges\" object of activity events always brings the full value of the travelling time).</p>",
            "title":"Travel Time"
        },
        "deliveryWindowStart":{
            "type":"string",
            "description":"The time when the activity delivery window starts. The time is displayed in the time zone of the resource to which the activity is assigned and is in HH:MM:SS format.",
            "title":"Delivery Window Start"
        },
        "city":{
            "type":"string",
            "description":"The city of the customer where the activity is scheduled. Maximum field length is 60. If a longer value is sent it will be truncated.",
            "title":"City"
        },
        "customerName":{
            "type":"string",
            "description":"The name of the customer. Maximum field length is 420. If a longer value is sent it will be truncated.",
            "title":"Customer Name"
        },
        "timeOfBooking":{
            "type":"string",
            "description":"The time when the customer booked the activity. The time is displayed in the time zone of the customer.",
            "title":"Time Of Booking"
        },
        "stateProvince":{
            "type":"string",
            "description":"The state or province of the customer. This field is used for geocoding and must contain a valid address. Maximum field length is 60. If a longer value is sent it will be truncated.",
            "title":"State Province"
        },
        "streetAddress":{
            "type":"string",
            "description":"The street address of the customer. This field is used for geocoding and must contain a valid address. Maximum field length is 240. If a longer value is sent it will be truncated.",
            "title":"Street Address"
        },
        "longitude":{
            "type":"number",
            "minimum":-180,
            "maximum":180,
            "description":"The geographic longitude coordinate that specifies the location of the activity.",
            "title":"Longitude"
        },
        "duration":{
            "$ref":"#/definitions/durationOutput"
        },
        "timeOfAssignment":{
            "type":"string",
            "description":"The time when the activity is assigned to the technician. This time is displayed in the time zone of the resource to which the activity is assigned.",
            "title":"Time Of Assignment"
        },
        "points":{
            "type":"integer",
            "minimum":0,
            "maximum":65535,
            "description":"The cost of the activity in 'points'. This field is intended for use by the Routing module.",
            "title":"Points"
        },
        "timeDeliveredStart":{
            "$ref":"#/definitions/timeDeliveredStartInput"
        },
        "resourceId":{
            "type":"string",
            "description":"The identifier of the resource to which this activity is assigned. This field is not returned if the resource ID is empty. <p><b>Note:</b> Do not use empty strings in requests.</p>",
            "title":"Resource ID"
        },
        "reminderTime":{
            "type":"integer",
            "description":"The number of minutes before the activity start time when the customer must be notified of the activity.",
            "title":"Reminder Time"
        },
        "country_code":{
            "type":"string",
            "description":"The code of the country where the activity is scheduled.",
            "title":"Country Code"
        },
        "activityType":{
            "type":"string",
            "description":"The label of the activity type. Based on the activity type, predefined company-specific rules are applied while processing an activity. Predefined company-specific rules cover the following:\n<ul><li>The resources to which the activity is assigned.</li>\n<li>The activity processing details.</li>\n<li>The interaction of the activity with different modules of Oracle Field Service.</li></ul>",
            "title":"Activity Type"
        },
        "apptNumber":{
            "type":"string",
            "description":"This field may be used by integrations to store the identifier of the activity in the origin system. This field has no business significance in Oracle Field Service and can be left empty. Maximum field length is 40.",
            "title":"Appointment Number"
        },
        "masterActivityId":{
            "type":"integer",
            "description":"The identifier of a segmentable activity. It is available for individual segments which have the record type set to 'multiday_activity_segment'. This field is not set for regular activities.",
            "title":"Master Activity ID"
        },
        "deliveryWindowEnd":{
            "type":"string",
            "description":"The time when the activity delivery window ends. The time is displayed in the time zone of the resource to which the activity is assigned and is in HH:MM:SS format.",
            "title":"Delivery Window End"
        },
        "status":{
            "type":"string",
            "enum":[
                "cancelled",
                "completed",
                "suspended",
                "started",
                "enroute",
                "pending",
                "notdone"
            ],
            "description":"The status of the activity. As a technician works through the activity, the status changes. The actions that are available for an activity are based on this status. <p>A newly created activity has the status as 'pending', but it can then be changed to 'cancelled' or 'started'. The status of an activity can be changed to 'complete', 'notdone', or 'suspended' only if it has the status as 'started'.</p>",
            "title":"Status"
        },
        "language":{
            "type":"string",
            "description":"The preferred language of the customer. This parameter returns two-character code (e.g. \"en\") in API responses. To obtain ISO code of the language (e.g. \"en-US\") read the \"languageISO\" parameter. In the requests this parameter accepts both formats (e.g. \"en\" or \"en-US\"). It is recommended to use ISO format. The language codes listed on:  <a href=\"OFSC_Supported_Language_Codes.html\">Supported Language Codes</a>.",
            "title":"Language"
        },
        "languageISO":{
            "type":"string",
            "description":"The preferred language of the customer. This parameter is only present in the responses and will be ignored if it is present in a request. To update language use the parameter \"language\". The language codes listed on:  <a href=\"OFSC_Supported_Language_Codes.html\">Supported Language Codes</a>.",
            "title":"Language ISO"
        },
        "positionInRoute":{
            "type":"integer",
            "description":"The position of the activity in the route. For not-ordered activities, this field is not present in the response. For ordered activities, a 1-based number is returned.",
            "title":"Position In Route"
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code of the customer. This field is used for geocoding and must contain a valid address. Maximum field length is 60. If a longer value is sent it will be truncated.",
            "title":"Postal Code"
        },
        "timeDeliveredEnd":{
            "$ref":"#/definitions/timeDeliveredEndInput"
        },
        "timeSlot":{
            "type":"string",
            "description":"The time slot during which the activity is completed. The time slot also indicates the service window for the activity.",
            "title":"Time Slot"
        },
        "latitude":{
            "type":"number",
            "minimum":-90,
            "maximum":90,
            "description":"The geographic latitude coordinate that specifies the location of the activity.",
            "title":"Latitude"
        },
        "recordType":{
            "type":"string",
            "enum":[
                "regular",
                "reopened",
                "prework",
                "multiday_activity",
                "multiday_activity_segment"
            ],
            "description":"The type of the activity record. The following values are allowed:<ul><li>regular: This is the default record type for most new activities.</li><li>prework: This type of record is created if a technician has to perform some work before the actual activity starts.</li><li>reopened: A record of this type is created when an activity is reopened for some reason.</li><li>multiday_activity: This record type is created when the 'activityType' indicates that it is a segmentable activity.</li><li>multiday_activity_segment: A number of records of this type are created for segmentable activities, based on their duration and time slot settings.</li></ul>",
            "title":"Record Type"
        },
        "customerCell":{
            "type":"string",
            "description":"The cell phone number of the customer. From version 17.2.1, the phone number is saved with the '+' symbol. For example, if you enter the phone number as [phone]_42, it is saved as [phone]. In versions before 17.2.1, the phone number is saved as 12342342342. Maximum field length is 240. If a longer value is sent it will be truncated.",
            "title":"Customer Cell"
        },
        "customerNumber":{
            "type":"string",
            "description":"The account number of the customer. This field is used by integrations as a placeholder for the external identifier of the Account ID in the application. This parameter has no business significance in Oracle Field Service and can be left empty. Maximum field length is 40. If a longer value is sent it will be truncated.",
            "title":"Customer Number"
        },
        "firstManualOperationUser":{
            "type":"string",
            "description":"The user who performed the first manual operation on the activity.",
            "title":"First Manual Operation User"
        },
        "customerPhone":{
            "type":"string",
            "description":"The regular (land) phone number of the customer. From version 17.2.1, the phone number is saved in Oracle Field Service with the '+' symbol. For example, if you enter the phone number as [phone]_42, it is saved in Oracle Field Service as [phone]. In versions before 17.2.1, the phone number is saved as 12342342342. Maximum field length is 240. If a longer value is sent it will be truncated.",
            "title":"Customer Phone"
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "title":"Activity ID"
        },
        "autoRoutedToDate":{
            "type":"string",
            "description":"The date to which the activity was moved automatically by routing. Rescheduling the activity does not change this value. It is a read-only field.",
            "title":"Auto Routed To Date"
        },
        "autoRoutedToResource":{
            "type":"string",
            "description":"The external ID of resource to which the activity was last assigned by routing. Reassigning the activity does not change this value. It is a read-only field. If the field has no value, it means that the routing assigned the activity to a resource with empty external ID.",
            "title":"Auto Routed To Resource"
        },
        "travelEstimationMethod":{
            "type":"string",
            "description":"The travel estimation method. It is a read-only field. The following values are returned:<p><ul><li>Airline Distance</li><li>Airline Distance and Statistics</li><li>External Adjustment</li><li>Manual Adjustment</li><li>Not Estimated</li><li>Point to Point</li><li>Same Location</li><li>Statistics</li><li>Street Level Routing</li><li>Travel key based Airline Distance</li><li>Using Defaults</li></ul></p>",
            "title":"Travel Estimation Method"
        },
        "coordinateAccuracy":{
            "type":"string",
            "description":"The coordinate accuracy of the activity. It is a read-only field. The following values are returned:<p><ul><li>Low</li><li>Medium</li><li>High</li></ul></p>",
            "title":"Coordinate Accuracy"
        },
        "activityFlow":{
            "type":"string",
            "description":"Activity flow label",
            "title":"Activity Flow"
        },
        "ibAssetId":{
            "type":"integer",
            "description":"The identifier of the installed based asset the activity is linked to. Optional field. Foreign key to CSE_ASSETS_B.ASSET_ID in Fusion.",
            "title":"ibAsset Id"
        },
        "pjfProjectElementId":{
            "type":"integer",
            "description":"The identifier of the project task the activity is linked to. Optional field. Foreign key to PJF_PROJ_ELEMENTS_B.PROJ_ELEMENT_ID in Fusion.",
            "title":"pjfProject Element Id"
        },
        "pjfProjectId":{
            "type":"integer",
            "description":"The identifier of the project the activity is linked to. Optional field. Foreign key to PJF_PROJECTS_ALL_B.PROJECT_ID in Fusion.",
            "title":"pjfProject Id"
        },
        "svcWorkOrderId":{
            "type":"integer",
            "description":"The identifier of the fusion service work order the activity is linked to. Optional field. Foreign key to SVC_WORK_ORDERS.WO_ID in Fusion.",
            "title":"svcWorkOrder Id"
        },
        "wieWorkOrderId":{
            "type":"integer",
            "description":"The identifier of the maintenance work order the activity is linked to. Optional field. Foreign key to WIE_WORK_ORDERS_B.WORK_ORDER_ID in Fusion.",
            "title":"wieWorkOrder Id"
        },
        "wieWorkOrderOperationId":{
            "type":"integer",
            "description":"The identifier of the maintenance work order operation the activity is linked to. Optional field. Foreign key to WIE_WO_OPERATIONS_B.WO_OPERATION_ID in Fusion.",
            "title":"wieWorkOrderOperation Id"
        }
    },
    "type":"object",
    "title":"Activity Properties",
    "description":"The array of activity property objects."
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(required): string
  The detailed description of this error.
• status(required): string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title",
        "status",
        "detail"
    ]
}

Back to Top

Examples

The following example shows how to get resource route for resources by submitting a GET request on the REST resource.

cURL command Example

curl -X GET \
 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/routing/routes/2018-06-27?activityFields=resourceId,resourceInternalId,apptNumber,activityId,city' \
 -H 'Authorization: Basic YWRtaW5Ab2ZzYy01NmZlNTcudGVzdDox' \
 -H 'Cache-Control: no-cache'

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.3
Date: Wed, 17 Sep 2015 15:32:19 GMT
Content-Type: application/json; charset=utf-8
Connection: close
X-Powered-By: PHP/5.5.28

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
 "totalResults": 2,
 "limit": 100,
 "offset": 0,
 "items": [
 {
 "activityId": 4225452,
 "resourceId": "ASIA",
 "resourceInternalId": 8101693
 },
 {
 "activityId": 4225453,
 "resourceId": "ASIA",
 "resourceInternalId": 8101693,
 "apptNumber": "10024",
 "city": "New York"
 }
 ],
 "links": [
 {
 "rel": "canonical",
 "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/ASIA/routes/2018-06-27?activityFields=resourceId%2CresourceInternalId%2CapptNumber%2CactivityId%2Ccity"
 },
 {
 "rel": "describedby",
 "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/metadata-catalog/resources"
 }
 ]
}

Back to Top