API Documentation - All calls available at http://www.instances.de/dfg/
test data generator - version 1.08


getinstances.php: Call to generate and/or store a file
Attribute Description Mandatory Valid values
instances Number of basic instances in a file. Yes type: integer
containers Number of containers per case. Yes type: container
block Dimensions of the block: gantry x trolley x spreader. Yes 10x10x5
handover_position Alignment of the handover area. Yes 1,2
version The version number of the generator. Default is 1_08 No 1_08
id Once present the file generation data is stored in our DB under the given id and project. No type: string
project The name of the project the file is assigned. Use this flag to store a file in the DB. Only works with a given id. No type: string
file Name of the file. Default is no_file_name No type: string
type The export format. Default is csv. No csv, xml, txt
download Choose 'yes' to download the file starts after the generation process, and 'no' to displayed the file on the web page. Default is yes. No yes, no
method Random method in use. Default is twister No twister, pseudo
type Random method in use. No type: string
seednumber An alphanumeric seed used to initialize our pseudorandom number generator. No type: string
origin_gantry_slot Distribution of the origin gantry slots. No type: distribution
origin_trolley_slot Distribution of the origin trolley slots. No type: distribution
origin_spreader_slot Distribution of the origin spreader slots. No type: distribution
destination_gantry_slot Distribution of the destination gantry slots. No type: distribution
destination_trolley_slot Distribution of the destination trolley slots. No type: distribution
destination_spreader_slot Distribution of the destination spreader slots. No type: distribution
destination_gantry_slot_2 Distribution of the destination gantry slots. No type: distribution
destination_trolley_slot_2 Distribution of the destination trolley slots. No type: distribution
destination_spreader_slot_2 Distribution of the destination spreader slots. No type: distribution
stacking_value Distribution of the stacking values. No type: distribution
release_date Distribution of the release dates. No type: distribution
due_date Distribution of the due dates. No type: distribution
stacking_value Distribution of the stacking values. No type: distribution
value, value_2, value_3, ... Distribution of the abstract values. No type: distribution
gap The gap value between the release and due dates. No type: integer
precedence The precedence option selected. No random, chain, batch
precedence_value A list of parameters used to generate precedence relations. No type: precedence

Example 1: Generate and download a file: getinstances.php?file=test&instances=1&method=twister&format=csv&version=1_08&containers=1:10&block=40&destination_gantry_slot=1:U|1,40&seed=42&handover_position=1
Example 2: Display a file: getinstances.php?file=test&instances=1&method=twister&format=csv&version=1_08&containers=1:10&block=40&destination_gantry_slot=1:U|1,40&seed=42&handover_position=1&download=no
Example 3: Store and download a file with a given id: getinstances.php?file=test&instances=1&method=twister&format=csv&version=1_08&containers=1:10&block=40&destination_gantry_slot=1:U|1,40&seed=42&handover_position=1&id=7cavtk7&project=test
Example 4: Change the column "destination_gantry_slot" to "gantry": getinstances.php?file=test&instances=1&method=twister&format=csv&version=1_08&containers=1:10&block=40&destination_gantry_slot=1:U|1,40{gantry}&seed=42&handover_position=1


datatypes
Type Description Input Example
distribution uniform U|a,b U|1,40
normal N|μ,σ N|20,5
truncated normal T|μ,σ,a,b T|20,5,1,40
arbitrary C|p1,v1-p2,v2-p3,v3 ... C|0.5,A-0.25,B-0.25,C
container A given number of containers per case casenumber1:integer_casenumber2:integer 1:50_3:20_6:50
container distribution Distribution of containers per case casenumber1:distribution_casenumber2:distribution 1:U|10,30_3:U|20,40
precedence random target density 0.55
chain chain probability, min, max 0.5,2,5
batch chain probability, min, max, number of batches 0.5,2,5,10



loadinstances.php: Call to load a file with given id
Attribute Description Mandatory Valid values
id id to be loaded. Yes type: string
instances Number of basic instances to be loaded. No type: integer
download Specifies whether the download of the created file starts after the generation process, or whether the data is displayed on the web page. Default is yes. No yes, no

Example 1: Download file id '7cavtk7': loadinstance.php?id=7cavtk7
Example 2: Download file id '7cavtk7' with 10 basic instances: loadinstance.php?id=7cavtk7&instances=10
Example 3: Display file id '7cavtk7' with 10 basic instances: loadinstance.php?id=7cavtk7&instances=10&download=no


loadproject.php: Call to load a project with a given name
Attribute Description Mandatory Valid values
project The project name to load. Yes type: string

Example 1: Download project 'examples': loadproject.php?project=examples


lockproject.php: Call to lock and publish an existing project. Can not be undone. Afterwards, no further changes can be made.
Attribute Description Mandatory Valid values
project The project name to lock and publish. type: string

Example 1: Lock project 'examples': lockproject.php?project=examples


remove.php: Call to remove a given file from the DB. Only works with unpublished projects and the assigned project name.
Attribute Description Mandatory Valid values
id The file id to remove. Yes type: string
project The project name of the file id to remove. Yes type: string

Example 1: Remove id '7cavtk7' in project 'test': remove.php?id=7cavtk7&project=test