Update activity duration statistics

patch

/rest/ofscStatistics/v1/activityDurationStats

This operation updates the activity duration override for the activity duration key that is currently active.

It is possible to override the activity duration either at the company level or at the technician level. To override the activity duration at the company level, the 'resourceId' field must be empty.

If there are multiple activity duration keys configured in the system, the overrides are applicable only to the activity duration key that is currently active. If the activity duration key is modified, then the overrides for that key are deleted from the system. However, the overrides persist if another activity duration key is active, with the old key in the system being inactive state. If the inactive key is set to active again, the overrides that were set corresponding to that key become applicable for the duration estimates.

For the activity duration key that is currently active, the override value is stored in the system along with the statistically learned value. For activity duration estimates, if an override is specified, then the override value is used instead of the statistically learned value. However, the statistically learned value is updated based on the new durations reported. At any point of time, it is possible to stop using the overrides by importing the data again with value 0 in the 'override' field. In such cases, the system starts using the statistically learned value for the duration estimates.

Note:

  • When the Statistics API is used to make activity duration changes, the changes are reflected for all future activities in the application only after the next run of the statistics agent. The statistics agent is run once a day, usually in the early morning hours.
  • The limit for each API request is 10000 records. To update more records, multiple requests can be used.
  • The following error messages are supported for the HTTP Code 400 response on this operation:

    • Maximum number of resource data exceeded. Limit 10000
    • Invalid structure. Items tag missing
    • Invalid structure. Additional tags found under data
    • Invalid structure. <resourceId|akey|override> tag missing
    • Property <resourceId|akey|override> value not set
    • Non numeric property value. Property: override
    • Negative property value not allowed. Property: override
    • Property value should be less than 1440
    • Property akey value length should not exceed 50

    The operation can be used only when the following conditions are satisfied:

    • The customer must have a subscription to Oracle Field Service Professional or Enterprise Cloud Service.
    • The required application must have permission to access the Statistics API. To grant the permission, navigate to Configuration, Applications screen. For the required application, click Add new in the API access section, and select Statistics API.

    Request

    Body ()
    This section describes the request body parameters for this operation.
    Root Schema : activityDurationRequestList
    Type: object
    The schema of the request body object for this operation.
    Show Source
    Nested Schema : items
    Type: array
    Show Source
    Nested Schema : Activity Duration Request
    Type: object
    Title: Activity Duration Request
    Show Source
    • Title: Appointment Key
      The value of the activity duration key. It appears as 'Appointment Key' in the report.
    • The override value that needs to be set for the 'resourceId' and 'akey' combination. For example, 100.
    • Title: Resource ID
      The external ID of the resource. If this value is not provided, the override will be performed at the company level.
    Back to Top

    Response

    Supported Media Types

    200 Response

    This section describes the 200 status response for this operation.
    Body ()
    Root Schema : activityDurationPatchResponse
    Type: object
    Show Source
    Nested Schema : results
    Type: object
    Show Source

    Default Response

    This section describes the default error response for this operation.
    Body ()
    Root Schema : Error
    Type: object
    Error response
    Show Source
    Back to Top

    Examples

    The following example shows how to set or update the activity duration override for activity duration keys by submitting a PATCH request on the REST resource using cURL:

    cURL Command Example

    curl -X PATCH \
      https://<instance_name>.etadirect.com/rest/ofscStatistics/v1/activityDurationStats \
      -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' \
      -H 'content-type: application/json' \
      -d '{
    	"items": [
       {
           "resourceId": "routing_bucket_D-Tech-11",
             "akey": "79765",
             "override": 150
       },
       {
           "resourceId": "routing_bucket_D-Tech-12",
             "akey": "79763",
             "override": 130
       }]
    }
    

    Response Header Example

    The following shows an example of the response header.

    HTTP/1.1 200 OK
    Server: nginx/1.2.7
    Date: Mon, 18 Dec 2017 02:20:33 GMT
    Content-Type: application/json; charset=utf-8
    

    Response Body Example

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

    {
        "status": "OK",
        "updatedrecords": 2
    }
    
    Back to Top