Jump to

• Request
• Response

Get list of routing runs by date

get

/api/field-service/routing/v1/routingRuns/{resourceExternalId}/{date}

This operation retrieves a list of routing runs and key statistics for the specified resource and date.

Request

Path Parameters

• date(required): string
  Minimum Length: 10

  Maximum Length: 10

  The date of the scheduling run in YYYY-MM-DD format.
• resourceExternalId(required): string
  Minimum Length: 1

  Maximum Length: 32

  The external identifier of the resource (bucket).

Query Parameters

• limit: integer
  The maximum number of items returned in the response. If no value is specified, then it defaults to 10.
• offset: integer
  The number of items that are skipped in the response. If a value is not specified, then it defaults to zero. The value zero indicates that the retrieval starts from the beginning of the collection.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : routingRuns

Type: object

The collection of routing runs for the specified resource and date.

Show Source

• hasMore: boolean
  Contains one of the following values: true or false. The default value is true.

  True indicates there are more results that can be retrieved with successive paging requests. False or the value is not present, indicates, there are no more results or this is the final page.

• items: array items
  An array of routing runs.
• limit: integer
  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 10.
• offset: integer
  The offset value specified in the request.
• totalResults: integer
  The total number of the resource type records in the collection.

{
    "description":"The collection of routing runs for the specified resource and date.",
    "properties":{
        "items":{
            "type":"array",
            "description":"An array of routing runs.",
            "items":{
                "title":"Routing Run",
                "type":"object",
                "properties":{
                    "runId":{
                        "type":"integer",
                        "description":"Unique identifier of the routing run."
                    },
                    "started":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Run start timestamp in ISO-8601 format."
                    },
                    "resourceExternalId":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":32,
                        "description":"External identifier of the resource."
                    },
                    "schedulingPlanId":{
                        "type":"integer",
                        "description":"Identifier of the scheduling plan."
                    },
                    "planName":{
                        "type":"string",
                        "description":"Name of the scheduling plan."
                    },
                    "planLabel":{
                        "type":"string",
                        "description":"Label of the scheduling plan."
                    },
                    "schedulingPlanType":{
                        "type":"string",
                        "description":"Run type derived from plan profile and creator.",
                        "enum":[
                            "manual",
                            "onceaday",
                            "recurrent",
                            "immediate",
                            "continuous"
                        ]
                    },
                    "runStartType":{
                        "type":"string",
                        "description":"How the run was started.",
                        "enum":[
                            "automatic",
                            "manual"
                        ]
                    },
                    "activitiesToBeAssigned":{
                        "type":"integer",
                        "description":"Number of activities to be assigned."
                    },
                    "assignedActivities":{
                        "type":"integer",
                        "description":"Number of activities assigned."
                    },
                    "totalResources":{
                        "type":"integer",
                        "description":"Total number of resources considered in the run."
                    },
                    "resourcesChangedRoutes":{
                        "type":"integer",
                        "description":"Number of resources with changed routes."
                    },
                    "resultStatus":{
                        "type":"string",
                        "description":"Current status of the run.",
                        "enum":[
                            "undefined",
                            "rolledback",
                            "scheduled",
                            "running",
                            "completed",
                            "waiting",
                            "stopped",
                            "skipped",
                            "failed"
                        ]
                    }
                },
                "required":[
                    "runId"
                ]
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of the resource type records in the collection. "
        },
        "hasMore":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. The default value is true.<p>True indicates there are more results that can be retrieved with successive paging requests. False or the value is not present, indicates, there are no more results or this is the final page.</p>"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "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 10."
        }
    }
}

Nested Schema : items

Type: array

An array of routing runs.

Show Source

• Array of: object Routing Run
  Title: Routing Run

{
    "type":"array",
    "description":"An array of routing runs.",
    "items":{
        "title":"Routing Run",
        "type":"object",
        "properties":{
            "runId":{
                "type":"integer",
                "description":"Unique identifier of the routing run."
            },
            "started":{
                "type":"string",
                "format":"date-time",
                "description":"Run start timestamp in ISO-8601 format."
            },
            "resourceExternalId":{
                "type":"string",
                "minLength":1,
                "maxLength":32,
                "description":"External identifier of the resource."
            },
            "schedulingPlanId":{
                "type":"integer",
                "description":"Identifier of the scheduling plan."
            },
            "planName":{
                "type":"string",
                "description":"Name of the scheduling plan."
            },
            "planLabel":{
                "type":"string",
                "description":"Label of the scheduling plan."
            },
            "schedulingPlanType":{
                "type":"string",
                "description":"Run type derived from plan profile and creator.",
                "enum":[
                    "manual",
                    "onceaday",
                    "recurrent",
                    "immediate",
                    "continuous"
                ]
            },
            "runStartType":{
                "type":"string",
                "description":"How the run was started.",
                "enum":[
                    "automatic",
                    "manual"
                ]
            },
            "activitiesToBeAssigned":{
                "type":"integer",
                "description":"Number of activities to be assigned."
            },
            "assignedActivities":{
                "type":"integer",
                "description":"Number of activities assigned."
            },
            "totalResources":{
                "type":"integer",
                "description":"Total number of resources considered in the run."
            },
            "resourcesChangedRoutes":{
                "type":"integer",
                "description":"Number of resources with changed routes."
            },
            "resultStatus":{
                "type":"string",
                "description":"Current status of the run.",
                "enum":[
                    "undefined",
                    "rolledback",
                    "scheduled",
                    "running",
                    "completed",
                    "waiting",
                    "stopped",
                    "skipped",
                    "failed"
                ]
            }
        },
        "required":[
            "runId"
        ]
    }
}

Nested Schema : Routing Run

Type: object

Title: Routing Run

Show Source

• activitiesToBeAssigned: integer
  Number of activities to be assigned.
• assignedActivities: integer
  Number of activities assigned.
• planLabel: string
  Label of the scheduling plan.
• planName: string
  Name of the scheduling plan.
• resourceExternalId: string
  Minimum Length: 1

  Maximum Length: 32

  External identifier of the resource.
• resourcesChangedRoutes: integer
  Number of resources with changed routes.
• resultStatus: string
  Allowed Values: [ "undefined", "rolledback", "scheduled", "running", "completed", "waiting", "stopped", "skipped", "failed" ]

  Current status of the run.
• runId(required): integer
  Unique identifier of the routing run.
• runStartType: string
  Allowed Values: [ "automatic", "manual" ]

  How the run was started.
• schedulingPlanId: integer
  Identifier of the scheduling plan.
• schedulingPlanType: string
  Allowed Values: [ "manual", "onceaday", "recurrent", "immediate", "continuous" ]

  Run type derived from plan profile and creator.
• started: string(date-time)
  Run start timestamp in ISO-8601 format.
• totalResources: integer
  Total number of resources considered in the run.

{
    "title":"Routing Run",
    "type":"object",
    "properties":{
        "runId":{
            "type":"integer",
            "description":"Unique identifier of the routing run."
        },
        "started":{
            "type":"string",
            "format":"date-time",
            "description":"Run start timestamp in ISO-8601 format."
        },
        "resourceExternalId":{
            "type":"string",
            "minLength":1,
            "maxLength":32,
            "description":"External identifier of the resource."
        },
        "schedulingPlanId":{
            "type":"integer",
            "description":"Identifier of the scheduling plan."
        },
        "planName":{
            "type":"string",
            "description":"Name of the scheduling plan."
        },
        "planLabel":{
            "type":"string",
            "description":"Label of the scheduling plan."
        },
        "schedulingPlanType":{
            "type":"string",
            "description":"Run type derived from plan profile and creator.",
            "enum":[
                "manual",
                "onceaday",
                "recurrent",
                "immediate",
                "continuous"
            ]
        },
        "runStartType":{
            "type":"string",
            "description":"How the run was started.",
            "enum":[
                "automatic",
                "manual"
            ]
        },
        "activitiesToBeAssigned":{
            "type":"integer",
            "description":"Number of activities to be assigned."
        },
        "assignedActivities":{
            "type":"integer",
            "description":"Number of activities assigned."
        },
        "totalResources":{
            "type":"integer",
            "description":"Total number of resources considered in the run."
        },
        "resourcesChangedRoutes":{
            "type":"integer",
            "description":"Number of resources with changed routes."
        },
        "resultStatus":{
            "type":"string",
            "description":"Current status of the run.",
            "enum":[
                "undefined",
                "rolledback",
                "scheduled",
                "running",
                "completed",
                "waiting",
                "stopped",
                "skipped",
                "failed"
            ]
        }
    },
    "required":[
        "runId"
    ]
}

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