Retrieve lists of all enabled wizard templates
get
/spms/v1/wizardTemplates/enabled
This is to retrieve lists of all enabled wizard templates
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Ok
Root Schema : List of wizard template
Type:
object
Title:
List of wizard template
List of wizard template
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object WizardTemplatesResponse
Wizard Templates
Nested 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
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"Invalid parameter(s) passed in"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"You are forbidden to use this API"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Allowed",
"detail":"The method is not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
"title":"Unsupported Media Type",
"detail":"The media supplied is not supported"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Error occurred while processing this request"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source