smartFlexOnboardingWizards

A list of wizards for onboarding devices for an account and property.

Arguments

accountNumber : String!


            required

The account number, e.g. A-12345678.

includeCancelled : Boolean

Include cancelled wizards.

includeCompleted : Boolean

Include completed wizards.

isResumable : Boolean

Filters for onboarding wizards that can be resumed. List limits to one resumable wizard.

propertyId : Int

Only list wizards for this property.

wizardId : ID

To get a specific wizard by ID, if it exists.

Returns

[SmartFlexOnboardingWizard!]

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query SmartFlexOnboardingWizards(
  $accountNumber: String!,
  $includeCancelled: Boolean,
  $includeCompleted: Boolean,
  $isResumable: Boolean,
  $propertyId: Int,
  $wizardId: ID
) {
  smartFlexOnboardingWizards(
    accountNumber: $accountNumber,
    includeCancelled: $includeCancelled,
    includeCompleted: $includeCompleted,
    isResumable: $isResumable,
    propertyId: $propertyId,
    wizardId: $wizardId
  ) {
    backendScreen {
      ... on ComponentListType {
        ...ComponentListTypeFragment
      }
      ... on Dashboard {
        ...DashboardFragment
      }
      ... on FormScreenType {
        ...FormScreenTypeFragment
      }
      ... on GenericBackendScreen {
        ...GenericBackendScreenFragment
      }
    }
    completedSteps {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
    currentStep {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
    deviceType
    displayName
    id
    isComplete
    resumable {
      ...SmartFlexResumableFragment
    }
  }
}

{
  "accountNumber": "A-4B6CC1F7",
  "includeCancelled": true,
  "includeCompleted": true,
  "isResumable": true,
  "propertyId": 48557656,
  "wizardId": "66472621"
}

{
  "data": {
    "smartFlexOnboardingWizards": [
      {
        "backendScreen": ComponentListType,
        "completedSteps": SmartFlexOnboardingStepInterface,
        "currentStep": SmartFlexOnboardingStepInterface,
        "deviceType": "BATTERIES",
        "displayName": "reality-item-since-magazine-resource",
        "id": "75951442",
        "isComplete": true,
        "resumable": SmartFlexResumable
      }
    ]
  }
}