Start Response Schema¶

v2.json#/definitions/start-response

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none

start-response Type¶

object (Start Response)

Start Response Properties¶

Property	Type	Required	Nullable
starter	Merged	Required	cannot be null
status	`string`	Required	cannot be null
name	`string`	Required	cannot be null
body	`object`	Required	cannot be null
path	`string`	Required	cannot be null
copy	`boolean`	Optional	cannot be null
errors	`array`	Optional	cannot be null

starter¶

the current definition of the starter: may change during multi-step starters

starter

is required
Type: object (Starter)
cannot be null

starter Type¶

object (Starter)

any of

all of
- Starter Metadata
- Starter with Files
all of
- all of
  - Starter Metadata
  - Starter with Files
all of
- Starter Metadata
all of
- Starter Metadata
- Starter with Files

status¶

the current state of the Starter

status

is required
Type: string (Status)
cannot be null

status Type¶

string (Status)

status Constraints¶

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"error"`
`"continuing"`
`"done"`

name¶

the canonical name of the starter

name

is required
Type: string (Name)
cannot be null

name Type¶

string (Name)

body¶

user data populated by the client

body

is required
Type: object (Body)
cannot be null

body Type¶

object (Body)

path¶

the API path (/ delimited) to which files will be written

path

is required
Type: string (API Path)
cannot be null

path Type¶

string (API Path)

copy¶

copy files after starter is run (irrespective of status) if true

copy

is optional
Type: boolean (Force Copy)
cannot be null

copy Type¶

boolean (Force Copy)

errors¶

a listing of system and user errors created during a starter

errors

is optional
Type: string[] (Error Text)
cannot be null

errors Type¶

string[] (Error Text)