Jump to

• Request
• Response

Retrieve lists of all wizard templates

get

/spms/v1/wizardTemplates

This is to retrieve lists of all wizard templates

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok

Body ()

Root Schema : List of wizard template

Type: object

Title: List of wizard template

List of wizard template

Show Source

• items(optional): array items

{
    "title":"List of wizard template",
    "description":"List of wizard template",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WizardTemplatesResponse"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object WizardTemplatesResponse
  Wizard Templates

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WizardTemplatesResponse"
    }
}

Nested Schema : WizardTemplatesResponse

Type: object

Wizard Templates

Show Source

• enabled(optional): boolean
  This indicates whether this wizard is enabled

  Example: true
• id(optional): integer
  Minimum Value: 1

  This is the wizard template primary key

  Example: 1
• module(optional): integer
  This value is a foreign key from Module table

  Example: 1
• name(optional): string
  Minimum Value: 2

  Maximum Value: 100

  Pattern: ^[a-zA-Z0-9 ]*$

  Example: Wizard Template EURO
• stepTemplates(optional): array stepTemplates

{
    "description":"Wizard Templates",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the wizard template primary key"
        },
        "name":{
            "type":"string",
            "minimum":2,
            "maximum":100,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"Wizard Template EURO"
        },
        "module":{
            "type":"integer",
            "example":"1",
            "description":"This value is a foreign key from Module table"
        },
        "enabled":{
            "type":"boolean",
            "example":"true",
            "description":"This indicates whether this wizard is enabled"
        },
        "stepTemplates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StepTemplatesResponse"
            }
        }
    }
}

Nested Schema : stepTemplates

Type: array

Show Source

• Array of: object StepTemplatesResponse
  Step Templates

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StepTemplatesResponse"
    }
}

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 not

  Example: true
• id(optional): integer
  This is the primary key of the step template

  Example: 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 configured

  Example: 1
• step(optional): object Step
  Steps available for checkin
• stepId(optional): integer
  This is the step id that is configured in the this particular wizard

  Example: 1
• stepVersion(optional): integer
  This is the foreign key of the respective step template version number

  Example: 1001
• wizardId(optional): integer
  This is the primary key of the wizard

  Example: 1

{
    "description":"Step Templates",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "example":"1",
            "description":"This is the primary key of the step template"
        },
        "sequence":{
            "type":"integer",
            "minimum":1,
            "maximum":20,
            "example":"1",
            "description":"This is will be used for sorting so that the steps can be configured"
        },
        "stepId":{
            "type":"integer",
            "example":"1",
            "description":"This is the step id that is configured in the this particular wizard"
        },
        "wizardId":{
            "type":"integer",
            "example":"1",
            "description":"This is the primary key of the wizard"
        },
        "enabled":{
            "type":"boolean",
            "example":"true",
            "description":"Indicates whether this step template is enabled or not"
        },
        "stepVersion":{
            "type":"integer",
            "example":"1001",
            "description":"This is the foreign key of the respective step template version number"
        },
        "modifiable":{
            "type":"boolean",
            "example":"true"
        },
        "configurable":{
            "type":"boolean",
            "example":"true"
        },
        "step":{
            "$ref":"#/definitions/Step"
        }
    }
}

Nested Schema : Step

Type: object

Steps available for checkin

Show Source

• description(optional): string
  This is the alternative step name

  Example: LOGIN STEP
• id(optional): integer
  Minimum Value: 1

  This is the step primary key

  Example: 1
• isInBreadCrumbTrail(optional): boolean
  Indicates whether this step should be displayed on the user interface

  Example: true
• name(optional): string
  This is the step name

  Example: LOGIN

{
    "description":"Steps available for checkin",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the step primary key"
        },
        "name":{
            "type":"string",
            "description":"This is the step name",
            "example":"LOGIN"
        },
        "description":{
            "type":"string",
            "description":"This is the alternative step name",
            "example":"LOGIN STEP"
        },
        "isInBreadCrumbTrail":{
            "type":"boolean",
            "description":"Indicates whether this step should be displayed on the user interface",
            "example":"true"
        }
    }
}

204 Response

No Content

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/WizardTemplatesErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/WizardTemplatesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"You are forbidden to use this API"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/WizardTemplatesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Allowed",
        "detail":"The method is not available"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/WizardTemplatesErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/WizardTemplatesErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/WizardTemplatesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top