IVR IVR Data UploadsIVR Data Uploads
Overview
The IVR Data schema provides a simple way to upload data for types which are common across different models (such as transit sets) as well as data which are specific to certain solve requests.
Applicable models
- IVRData
ivrdata-o43e0dvs78zq
- IVR7
ivr7-kt461v8eoaif
(indirect) - IVR8
ivr8-yni1c9k2swof
(indirect)
Cached Transit Set
The cached transit set allows the user to upload a transit set to the API. The API returns a requestId
with a successful upload which may then be referenced in a transit generator for inclusion on any model being run with the same key. Data is scoped by key and cannot be shared across keys.
Schema definition
message CachedTransitSet {
required TransitSet transitSet = 1;
}
Fields
- transitSet
- A valid transit set object. The definition employed here is common across the IVR7/IVR8 schemas.
Cached Model
The cached model allows the user to upload a collection of model data which is considered static. This model may then be referenced in a solve request which allows a process to manipulate the task sequence or reoptimise a model previously uploaded given a valid starting point. The most common use case for this data type is the evaluate
solve request which permits users to link a user interface with a rapid call to the solver to allow quick results to a series of user edits to a particular sequence of tasks (while also evaluating potential infeasibilities).
Schema definition
message CachedModel {
required bytes model = 1;
}
Fields
- model
- A serialised byte array of a valid IVR7/IVR8 model. This includes a complete encapsulation of model components and potentially other data components such as cached transit sets.