POST api2/dialog.json

Execute Dialog

Request Information

URI Parameters

None.

Body Parameters

API.Models.ExecuteDialogRequest
NameDescriptionTypeAdditional information
dialog

API.Code.DeviceHelperAPI+eDialog

Required

fieldItems

Collection of API.Models.FieldItem

Required

unlockCode

Required for Register/Unlock

string

None.

deviceID

Required for ManageDevices

integer

None.

email

Required for Password-Dialog

string

None.

projectID

Required for DeauthorizeContent

integer

None.

licenseID

Required for DeauthorizeContent

integer

None.

Request Formats

{
  "dialog": "Register",
  "fieldItems": [
    {
      "ID": "sample string 1",
      "Type": "Text",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Values": "sample string 4"
    },
    {
      "ID": "sample string 1",
      "Type": "Text",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Values": "sample string 4"
    }
  ],
  "unlockCode": "sample string 1",
  "deviceID": 2,
  "email": "sample string 3",
  "projectID": 4,
  "licenseID": 5
}

Response Information

Resource Description

API.Models.ExecuteDialogResult
NameDescriptionTypeAdditional information
result

boolean

None.

unlockCode

string

None.

message

string

None.

url

string

None.

token

WebApp2.Code.OAuth+Token

None.

Response Formats

{
  "result": true,
  "unlockCode": "sample string 2",
  "message": "sample string 3",
  "url": "sample string 4",
  "token": {
    "access_token": "sample string 1",
    "refresh_token": "sample string 2",
    "token_type": "sample string 3",
    "expires_in": 4,
    "userName": "sample string 5",
    ".issued": "2024-06-13T10:28:10.8409351+02:00",
    ".expires": "2024-06-13T10:28:10.8409351+02:00"
  }
}