NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve a wizard template
get
/spms/v1/wizardTemplates/{id}
This is to retrieve a wizard template
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Returns a wizard template based on the id
Root Schema : WizardTemplatesResponse
Type:
object
Wizard Templates
Show Source
-
enabled(optional):
boolean
This indicates whether this wizard is enabledExample:
true
-
id(optional):
integer
Minimum Value:
1
This is the wizard template primary keyExample:1
-
module(optional):
integer
This value is a foreign key from Module tableExample:
1
-
name(optional):
string
Minimum Value:
2
Maximum Value:100
Pattern:^[a-zA-Z0-9 ]*$
Example:Wizard Template EURO
-
stepTemplates(optional):
array stepTemplates
Nested Schema : stepTemplates
Type:
Show Source
array
-
Array of:
object StepTemplatesResponse
Step Templates
Nested Schema : StepTemplatesResponse
Type:
object
Step Templates
Show Source
-
configurable(optional):
boolean
Example:
true
-
enabled(optional):
boolean
Indicates whether this step template is enabled or notExample:
true
-
id(optional):
integer
This is the primary key of the step templateExample:
1
-
modifiable(optional):
boolean
Example:
true
-
sequence(optional):
integer
Minimum Value:
1
Maximum Value:20
This is will be used for sorting so that the steps can be configuredExample:1
-
step(optional):
object Step
Steps available for checkin
-
stepId(optional):
integer
This is the step id that is configured in the this particular wizardExample:
1
-
stepVersion(optional):
integer
This is the foreign key of the respective step template version numberExample:
1001
-
wizardId(optional):
integer
This is the primary key of the wizardExample:
1
Nested Schema : Step
Type:
object
Steps available for checkin
Show Source
-
description(optional):
string
This is the alternative step nameExample:
LOGIN STEP
-
id(optional):
integer
Minimum Value:
1
This is the step primary keyExample:1
-
isInBreadCrumbTrail(optional):
boolean
Indicates whether this step should be displayed on the user interfaceExample:
true
-
name(optional):
string
This is the step nameExample:
LOGIN
400 Response
The supplied parameter(s) is not valid
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
401 Response
You are not authorized to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
The wizard template does not exist
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
405 Response
This method is not available
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
415 Response
The media supplied is not supported
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occurred while processing this request
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
502 Response
Bad Gateway
503 Response
Service not available