Create Wizard State

Create Wizard State

Create a wizard state for the logged in user. The application has goal based wizards to enable users to complete a number of steps to achieve a goal. This domain object persists the last step visited by the user. It does not imply that they have completed all preceding steps, nor even the current step.

Request
URI
POST
https://{api_host}/component-registry/api/wizardstates
COPY
Request Body

The wizard state to be created

WizardState of type(s) application/json
Required 
{
    "goalId": "string",
    "tenantId": "string",
    "id": "string",
    "userId": "string"
}
string
goalId
Optional

goalId

string
tenantId
Optional

tenantId

string As uuid As uuid
id
Optional

id

string
userId
Optional

userId

Responses
200

successful operation

Returns WizardState of type(s) */* 
{
    "goalId": "string",
    "tenantId": "string",
    "id": "string",
    "userId": "string"
}
string
goalId
Optional

goalId

string
tenantId
Optional

tenantId

string As uuid As uuid
id
Optional

id

string
userId
Optional

userId


201

Successfully saved a wizard state

Operation doesn't return any data structure

On This Page
Extensibility Wizard States Operations
POST
Create Wizard State
GET
Get the current wizard state for the logged In user
GET
Gets the wizard state identified By Id
DELETE
Remove A wizard state