GET api/Wizard/Configurations

Gets all wizard configurations.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns a collection of wizard configurations.

Collection of WorkPoint365.WebAPI.Model.WizardConfiguration

Name	Description	Type	Additional information
Id	Gets or sets the identifier.	globally unique identifier	None.
Title	Gets or sets the title.	string	Required
TitleResource	Gets or sets the title resource.	Dictionary of integer [key] and string [value]	None.
Description	Gets or sets the description.	string	None.
DescriptionResource	Gets or sets the description resource.	Dictionary of integer [key] and string [value]	None.
WizardType	Gets or sets the type of wizard	WorkPoint365.WebAPI.Model.WizardType	None.
Flows	Gets or sets the flows.	Collection of string	None.
Parameters	Gets or sets the parameters.	Dictionary of string [key] and string [value]	None.
Enabled	Gets or sets the availability of this wizard.	boolean	None.
EnabledForCommandBar	Gets or sets if the wizard should be available form the Modern UI command bar	boolean	None.
CanRunWithElevatedPermissions	Gets wether the wizard configuration can run with elevated permissions	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "4c7bc697-f860-4ca2-a69b-edf0bf7d7b99",
    "Title": "sample string 2",
    "TitleResource": {
      "1": "sample string 2",
      "3": "sample string 4"
    },
    "Description": "sample string 3",
    "DescriptionResource": {
      "1": "sample string 2",
      "3": "sample string 4"
    },
    "WizardType": 0,
    "Flows": [
      "sample string 1",
      "sample string 2"
    ],
    "Parameters": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Enabled": true,
    "EnabledForCommandBar": true,
    "CanRunWithElevatedPermissions": false
  },
  {
    "Id": "4c7bc697-f860-4ca2-a69b-edf0bf7d7b99",
    "Title": "sample string 2",
    "TitleResource": {
      "1": "sample string 2",
      "3": "sample string 4"
    },
    "Description": "sample string 3",
    "DescriptionResource": {
      "1": "sample string 2",
      "3": "sample string 4"
    },
    "WizardType": 0,
    "Flows": [
      "sample string 1",
      "sample string 2"
    ],
    "Parameters": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Enabled": true,
    "EnabledForCommandBar": true,
    "CanRunWithElevatedPermissions": false
  }
]

application/xml, text/xml

Sample:

<ArrayOfWizardConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <WizardConfiguration>
    <Description>sample string 3</Description>
    <DescriptionResource xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfintstring>
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </DescriptionResource>
    <Enabled>true</Enabled>
    <EnabledForCommandBar>true</EnabledForCommandBar>
    <Flows xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Flows>
    <Id>4c7bc697-f860-4ca2-a69b-edf0bf7d7b99</Id>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Parameters>
    <Title>sample string 2</Title>
    <TitleResource xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfintstring>
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </TitleResource>
  </WizardConfiguration>
  <WizardConfiguration>
    <Description>sample string 3</Description>
    <DescriptionResource xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfintstring>
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </DescriptionResource>
    <Enabled>true</Enabled>
    <EnabledForCommandBar>true</EnabledForCommandBar>
    <Flows xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Flows>
    <Id>4c7bc697-f860-4ca2-a69b-edf0bf7d7b99</Id>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Parameters>
    <Title>sample string 2</Title>
    <TitleResource xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfintstring>
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </TitleResource>
  </WizardConfiguration>
</ArrayOfWizardConfiguration>