iGUIDE Types
iGUIDE create input
| Property | Type | Description |
|---|---|---|
industry(mandatory) | string | A string indicating the Property Industry of iGUIDE to be created. Accepted Values:
Learn more about Property Industries |
type(mandatory) | string | A string indicating the type of iGUIDE to be created. Accepted Values:
Learn more about Packages |
editors | []string | A list of user IDs to be added as editors to the created iGUIDE. |
primaryContact | string | A user ID to be assigned as the primary contact to the created iGUIDE. |
reportSubscribers | []string | A list of email addresses to be subscribed to the iGUIDE’s report. |
webhooks | []Webhook | A list of webhooks to be added to the iGUIDE. See Webhooks |
address (mandatory) | Address | The iGUIDE address |
defaultView | ViewParams | Parameters for the Default View |
skipPrepublish | bool | This option is only applicable for draftable iGUIDE types such as standard or premium. When set to true, the iGUIDE will be published even if the Drafting team chooses to pre-publish it. |
applyDefaults | bool | Enabling this field will apply user-defined presets in following order
|
addons(obsolete) | []string | Obsolete: add-ons are automatically activated upon work order requests A list of paid addons to be purchased for the iGUIDE upon creation. Accepted values:
|
Work order create input
| Property | Type | Description |
|---|---|---|
types(mandatory) | []string | An array of strings specifying the types of work to be performed. Available task types depend on the iGUIDE package type. Available task types by iGUIDE package:
|
attrs | json | Additional attributes for your request. Depends on the task types being requested.
|
skipPrepublish | bool | This option is only applicable for draftable upgrade task types such as draft-convert or draft-premium-convert. When set to true, the iGUIDE will be published even if the Drafting team chooses to pre-publish it. |
taskType (obsolete) | string | Obsolete: use types instead.A string specifying the type of work to be performed. |
enableEsxAddon(obsolete) | bool | Obsolete: add-ons are automatically enabled upon work order requests |
enableFmlAddon(obsolete) | bool | Obsolete: add-ons are automatically enabled upon work order requests |