Insight REST API client

Topics covered in this chapter:

Introduction

The mminsightrestapi package implements a client for making calls to the Insight v5 REST webservice interfaces. You can use mminsightrestapi to create/update/delete apps, folders and scenarios; to read or write entity data, and to perform any other operation that is supported by the Insight REST webservices.

mminsightrestapi can be used both inside and outside of Insight apps. When used within an Insight scenario, there is no relationship between the calls made through mminsightrestapi and the currently running scenario (any reads/writes behave as though they came from outside of the scenario).

The mminsightrestapi subroutines and data structures implement a direct mapping to the Insight v5 REST webservice operations; it's recommended this package is only used where the required operation is not supported by the mminsightscenario package.

Initialization

Before making any calls to the webservices, you must initialize an insightapi2~insightconfig value with the URL of the Insight server, for example:

parameters
  INSIGHT_URL="http://localhost:8080/"
end-parameters
declarations
  cfg: insightapi2~insightconfig
end-declarations
insightapi2~insightconfig_init(cfg, INSIGHT_URL)

Provided that Mosel restrictions are not active, the package will automatically read your Insight REST API credentials from the Windows Credential Manager, or the Mac Keychain, or an encrypted file on Linux - consult the below section Providing REST API credentials for instructions on how to do this.

If you are not able to provide credentials securely using the Credential Manager / Keychain / etc, you can pass them to the insightapi2~insightconfig_init procedure directly, for example:

parameters
  INSIGHT_URL="http://localhost:8080/"
  CLIENT_ID=""
  SECRET=""
end-parameters
declarations
  cfg: insightapi2~insightconfig
end-declarations
insightapi2~insightconfig_init(cfg, INSIGHT_URL, CLIENT_ID, SECRET)

Once the insightapi2~insightconfig value is initialized, it should be passed to all requests to the Insight server, e.g.:

declarations
  apps: insightapi2~page_of_app
end-declarations
apps := insightapi2~get_apps(cfg, 0, 1000)

The credentials will not be validated until the first call to an Insight webservice operation - it is not possible for the call to insightapi2~insightconfig_init to fail.

Design Patterns

The mminsightrestapi package is derived directly from the public Insight OpenAPI specification and therefore is not aligned with normal Mosel design patterns in terms of type and function naming and record behaviour. For each operation supported by the Insight webservice interface, the package offers several subroutines that differ in what arguments are required. Each takes an insightapi2~insightconfig value containing details of the Insight webservices to use, and returns the expected return type of a 'successful' call (e.g. insightapi2~scenario in the case of insightapi2~create_scenario). The first subroutine variant takes the operation's input parameters and a insightapi2~httpresponse record into which details of the response will be written; for example to rename a scenario using this pattern:

declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  fields_to_update: insightapi2~scenario
  updated_scenario: insightapi2~scenario
  resp: insightapi2~httpresponse
end-declarations
fields_to_update.name := 'new name'
updated_scenario := insightapi2~update_scenario(cfg, SCENARIO_ID, fields_to_update, resp)
if not resp.success then
  writeln_('ERROR renaming scenario: ',resp.errormsg)
end-if

The second variant omits the insightapi2~httpresponse argument; when called in this way, the model will terminate with an error message if the operation fails, e.g.:

declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  fields_to_update: insightapi2~scenario
  updated_scenario: insightapi2~scenario
end-declarations
fields_to_update.name := 'new name'
updated_scenario := insightapi2~update_scenario(cfg, SCENARIO_ID, fields_to_update)
! Model will automatically terminate on failure

The final variant wraps the input parameters in an insightapi2~httprequest value; this is intended mostly for advanced use cases where you want to build up the parameters programmatically. To rename the scenario using this pattern, you would do this:

declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  fields_to_update: insightapi2~scenario
  updated_scenario: insightapi2~scenario
  resp: insightapi2~httpresponse
  req: insightapi2~httprequest
end-declarations
fields_to_update.name := 'new name'
req.params('id') := SCENARIO_ID
req.body := fields_to_update
updated_scenario := insightapi2~update_scenario(cfg, req, resp)
if not resp.success then
  writeln_('ERROR renaming scenario: ',resp.errormsg)
end-if

When making a call to an operation that returns a binary file, you should set the bodyfilename attribute of the insightapi2~httpresponse record to the path of the file to write to.

The data models of the Insight REST API have been converted into Mosel types which are described in the Data Model Types section of this document. These behave similarly to Mosel records, but have several important differences:

• All the fields are optional — unpopulated fields will return their default values if you try to access them but you can check if a field is present using the has<name> functions (e.g. to see if a insightapi2~attachment named att has a populated id field, call has_id(att)).
• All values stored in the fields are read-only — if a field contains a structured type, you must create that value in a local variable before assigning it to the field.
• You cannot use a record constructor to initialize or create new instances of any of the data model types.

The insightapi2~dictionary type (or a similar type such as insightapi2~dictionary_of_text) is used to represent a collection of named values. There is a standard pattern for accessing dictionaries where you can call insightapi2~get_value to access an individual named value but access a list of the name-value pairs in the entries field (or values if you want the values without the names). To edit the values in a dictionary, you use the insightapi2~put_value procedure.

Internally, requests to the Insight webservices are made through the dmp module and you can use the dmp_max_retries and dmp_retry_error_codes parameters to control how many times and which failed requests should be automatically retried, before returning an error to the calling code.

Providing REST API credentials

Overview

The recommended way to pass the Insight REST API credentials to the mminsightrestapi or mminsightscenario package is using your system's local secure storage. This section describes how to do this for each platform. Before adding your REST API credentials to the secure storage, you must obtain them from Insight for your account — consult the Insight 5 documentation for instructions.

You will not be able to provide credentials in this way if your Mosel will be executing in restricted mode, or on another server, or within an Insight execution worker, or within a role account. Consult the mminsightrestapi or mminsightscenario documentation for alternate ways to pass in credentials, but always remember that the client ID and secret values allow access to your account on the Insight 5 server, so must be handled securely.

Note that for Windows and Mac, this process is identical to providing REST API credentials to Workbench or to the Insight 5 Compute Interface; if you have already configured either, you do not need to repeat these steps again.

Windows

1. Open the Credential Manager, by typing credential manager in the search box on the taskbar and selecting Credential Manager Control Panel.
2. Select Windows Credentials to access the manager.
3. In the Generic Credentials list, click Add a generic credential
4. In the Internet or network address field, enter ficoxpress:<insight URL>, e.g. ficoxpress:http://localhost:8080
5. In the User name field, enter the Client ID value from Insight.
6. In the Secret field, enter the Client Secret value from Insight.
7. Click OK, then close the Credential Manager.

Mac

1. In Applications > Utilities, open the Keychain Access app on your Mac.
2. Select the login keychain in the Keychains list.
3. Select File > New Password Item.
4. In the Keychain Item Name field, enter ficoxpress:<insight URL>, e.g. ficoxpress:http://localhost:8080
5. In the Account Name field, enter the Client ID value from Insight.
6. In the Password field, enter the Client Secret value from Insight.
7. Click Add, then close the Keychain Access application.

Linux

On Linux, openssl tools are used to encrypt a file containing the Client id and Client secret.

To start, choose a location to save a keyfile. Set environment variable XPRESS_CREDENTIALS_DSO_AUTH_KEYFILE to the keyfile location. From the Linux bash shell, enter the following command and press Enter:

XPRESS_CREDENTIALS_DSO_AUTH_KEYFILE = keyfile_path

Note: For security, the <keyfile_path> should be on a different drive to the home directory.

Populate the key file with secure random data. Enter the following command and press Enter:

openssl rand -base64 -out $XPRESS_CREDENTIALS_DSO_AUTH_KEYFILE 48

To encrypt the Client ID and Client secret values into a file named .ficoxpress in your home directory, enter the following command, replacing CLIENTID and SECRET with the actual Client ID and Client secret values from the Insight Server:

(echo "CLIENTID" ; echo "SECRET" ) | openssl enc -aes-256-cbc -salt -md sha256 -out ~/.ficoxpress -pass file:$XPRESS_CREDENTIALS_DSO_AUTH_KEYFILE

In your Insight 5 execution worker configuration, you must configure the XPRESS_CREDENTIALS_DSO_AUTH_KEYFILE environment variable to be the same value used above.

If you wish to store the .ficoxpress file somewhere other than your home directory, you can set the XPRESS_CREDENTIALS_DSO_AUTH_DIR to the path of the alternate location.

Example: Creating a scenario

This example code demonstrates how to create a new scenario within an existing app. It assumes that cfg is an initialized insightapi2~insightconfig value and APP_ID is the ID of the app in which to create the scenario.

declarations
  appref: insightapi2~reference_app
  newscenreq: insightapi2~scenario_creation_request
  newscen: insightapi2~scenario
  resp: insightapi2~httpresponse
end-declarations

appref.id := APP_ID
appref.object_type := 'APP'
newscenreq.parent := appref
newscenreq.name := 'my scenario'

newscen := insightapi2~create_scenario(cfg, newscenreq, resp)
if not resp.success then
  writeln_('ERROR creating scenario: ',resp.errormsg)
  exit(1)
end-if
writeln('Created new scenario with ID: ',newscen.id)

Example: Updating an array

This example code demonstrates how to fetch the an entity 'prices' of type array(regions:set of string,items:set of integer) of real, double each value, and save this change back to the server. It assumes that cfg is an initialized insightapi2~insightconfig value and SCENARIO_ID is the ID of the scenario to modify.

declarations
  query: insightapi2~scenario_data_query
  data: insightapi2~scenario_data
  modifications: insightapi2~scenario_data_modification
  delta: insightapi2~entity_delta
  arrdelta: insightapi2~array_delta
  elem: insightapi2~array_element
  resp: insightapi2~httpresponse

  prices: dynamic array(regions:set of string,items:set of integer) of real
end-declarations

! Fetch array
query.entity_names := ['prices']
data := insightapi2~get_scenario_data(cfg, SCENARIO_ID, query, resp)
if not resp.success then
  writeln_('ERROR downloading "prices" entity: ',resp.errormsg)
  exit(1)
end-if

! Now copy the downloaded 'prices' entity into a local Mosel array.
! Start by finding the 'prices' entity in the scenario_data value
with prices_entity=insightapi2~get_value(data.entities, 'prices') do
  ! The array data will have been fetched in a nested set of dictionaries, the names in each
  ! being the index set values
  ! Iterate through the outer dictionary, which will be indexed by region name
  forall (region_entry in prices_entity.insightapi2~array.array.entries) do
    ! 'region_entry' value will be dictionary from region
    ! name to (dictionary from item ID as string to price value)
    forall (item_entry in region_entry.value.insightapi2~dictionary.entries) do
      ! 'item_entry' value will be value from prices array
      prices( string(region_entry.name), parseint(item_entry.name) ) := item_entry.value.real
    end-do
  end-do
end-do

! Next we update populate the arrdelta structure with an array_element for each element we
! want to update
forall (region in regions, item in items | exists(prices(region,item))) do
  reset(elem)
  elem.key := [region,item]
  elem.value := prices(region,item)*2
  arrdelta.add := arrdelta.add + [elem]
end-do
! Save the arraydelta describing the changes to this array into a scenario_data_modification
! record
delta.entity_name := 'prices'
delta.array_delta := arrdelta
modifications.deltas := [delta]
! Send the modification to the server
insightapi2~modify_scenario_data(cfg, SCENARIO_ID, modifications)
if not resp.success then
  writeln_('ERROR updating "prices" entity: ',resp.errormsg)
  exit(1)
end-if
writeln('Prices have been doubled.')

Be aware that if you are fetching an entity of type integer, the value arriving in Mosel will always be of type real - you will need to cast these to integer if the type is significant.

Example: Downloading an attachment

This example code demonstrates how to download a scenario attachment named 'alldata.xls' to a local file. It assumes that cfg is an initialized insightapi2~insightconfig value and SCENARIO_ID is the ID of the scenario.

declarations
  resp: insightapi2~httpresponse
  attach: insightapi2~attachment
  page: insightapi2~page_of_attachment
end-declarations

! Fetch the list of attachments and look for one with the name we want
page := insightapi2~get_scenario_attachments(cfg, SCENARIO_ID, 0, 1000, resp)
if not resp.success then
  writeln_('ERROR fetching list of scenario attachments: ',resp.errormsg)
  exit(1)
end-if
forall (att in page.content) do
  if att.filename='alldata.xls' then
    attach := att
    break
  end-if
end-do
if not has_id(attach) then
  ! Attachment record never populated
  writeln('Attachment "alldata.xls" not found')
  exit(1)
end-if

! Set the filename into which to save the attachment
resp.bodyfilename := 'alldata.xls'
! Download the attachment
insightapi2~get_scenario_attachment_file(cfg, SCENARIO_ID, attach.id, resp)
if not resp.success then
  writeln_('ERROR downloading attachment: ',resp.errormsg)
  exit(1)
end-if
writeln('Attachment downloaded')

Example: Uploading an attachment

This example code demonstrates how to create a scenario attachment named 'username.txt'. Note we specify the attachment content using a insightapi2~file_data record, specifying a local source filename containing the attachment content that has a different name from the attachment filename in the Insight server - the filename field can be left unpopulated if these are the same. We assume that cfg is an initialized insightapi2~insightconfig value and SCENARIO_ID is the ID of the scenario.

declarations
  public username='william shakespeare'
  resp: insightapi2~httpresponse
  attach: insightapi2~attachment
end-declarations

attach := insightapi2~upload_scenario_attachment(cfg, SCENARIO_ID,
  insightapi2~file_data(.source:='text:username', .filename:='username.txt'), true, "mytag", resp)
if not resp.success then
  writeln_('ERROR uploading attachment: ',resp.errormsg)
  exit(1)
end-if
writeln('Attachment uploaded')

REST Client Configuration

insightapi2~file_data  : record

The file_data record defines external data being uploaded to a webservice
source  : text
	The local filename from which to read the data to upload. Must be set.
filename  : text
	The filename to attach to the uploaded data in the Content-Disposition header; if unset, will be derived from the source filename
contenttype  : text
	The content type of the uploaded data; defaults to 'application/octet-stream' if unset

insightapi2~httprequest  : record

The httprequest record contains the request sent to an operation on the remote webservice.
params  : dynamic array(set of string) of any
	Parameters to set on the request. Refer to the operation documentation for a list of which parameters may be set for a specific operation.
contenttype  : text
	The content type of the request; only needs to be set if it can't be inferred by the operation or the type of the body field
bodyfilename  : text
	The filename from which to read the message body, if the request needs a body and the body field is unset.
body  : any
	The mosel value to use to populate the message body. Refer to the operation documentation for details on what types are supported by a specific operation.
headers  : dynamic array(set of string) of list of text
	Array defining additional HTTP headers to write to the request; a map from header name to list of header values to set.
ifparseresponsebody  : function(insightapi2~httpresponse):boolean
	Optional; a function that takes a insightapi2~httpresponse and returns 'true' if we shoudl try to parse the response body data from 'bodyfilename' to 'body', 'false' otherwise. If not specified, the operation will apply a default heuristic.

insightapi2~httpresponse  : record

The httpresponse record contains the response returned by an operation called on the remote webservice.
operid  : string
	The name of the operation from the REST API that was called.
status  : integer
	The HTTP status code; values between 200 and 299 usually indicate success.
success  : boolean
	Field indicating whether the status code indicates success (read-only)
errormsg  : text
	Field containing a suitable error message that describes a non-successful response. The error message will be built from the status code and any response body.
headers  : dynamic array(set of string) of list of text
	HTTP response headers; a map from header name (in lowercase) to a list of values for that header
contenttype  : text
	The content type of the HTTP response, e.g. 'application/json'
body  : any
	The value of the response body, if was a type that could be parsed into a Mosel value.
bodyfilename  : text
	The filename in which the response body was stored, if it could not be parsed into a Mosel value. Can be set before the operation is called to write the response into a specific file.
cookies  : dynamic array(set of string) of text
	Array of cookies set by the response
Note	The caller can set the bodyfilename attribute to force the response body to be written to a given filename; if unset, a temporary file will be used.

insightapi2~insightconfig  : record

The insightconfig type represents the remote webservice we're interacting with.
preprocessors  : list of procedure(string,insightapi2~httprequest)
	procedures that will be called for every outgoing request, allowing you to (for example) add additional headers (list of procedure(operationId:string, request:insightapi2~httprequest))
postprocessors  : list of procedure(string,insightapi2~httpresponse)
	procedures that will be called for every incoming request, allowing you to perform any post-processing on the request. (list of procedure(operationId:string, response:insightapi2~httpresponse)) Post-processors are called after the body file is parsed into Mosel data structures but before the raw data has been deleted to disk; ie the response can be read from the body or bodyfilename attributes of the httpresponse record (the former only if it's of a type that could be parsed into a Mosel value).
Notes	1. Use the insightapi2~insightconfig_init function to initialize the insightconfig before use. 2. Advanced users can add preprocessor/postprocessor callbacks to modify or log the interactions with the wbservice

Data Model Types

The data model defines the structures used to communicate with the remote API.

insightapi2~api_apps_body  : record

app_file  : insightapi2~file_data
	The app zip file used to create the app
app_name  : text
	The app name to use if none is present in the app configuration
override_app_name  : text
	The app name override, used as the new app name regardless of any other app configuration
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app_file(myapi_apps_body) then... 2. A api_apps_body returned from a property of another model will be read-only; use the function insightapi2~copy_api_apps_body to create an editable copy, e.g. myapi_apps_body := insightapi2~copy_api_apps_body(otherobj.originalapi_apps_body) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~file_data

insightapi2~api_computejobs_body  : record

compute_job_request  : insightapi2~compute_job_request
	computeJobRequest
payload  : insightapi2~file_data
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_compute_job_request(myapi_computejobs_body) then... 2. A api_computejobs_body returned from a property of another model will be read-only; use the function insightapi2~copy_api_computejobs_body to create an editable copy, e.g. myapi_computejobs_body := insightapi2~copy_api_computejobs_body(otherobj.originalapi_computejobs_body) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~compute_job_request insightapi2~file_data

insightapi2~app  : record

This object represents one app in the system. See the wider product documentation for an explanation of what an app is used for.
custom_scenario_types  : boolean
	Whether this app defines custom scenario types. False if the only scenario type is the default SCENARIO.
execution_modes  : insightapi2~dictionary_of_execution_mode
	The app's execution modes, mapped by name
help_url  : text
	The URL of this app's help documentation. This can either be a path relative to client resources or an absolute URL.
id  : text
	The ID of this app
mirror_defined  : boolean
	Whether a mirror has been defined within the companion file for this app
model  : insightapi2~app_model
	Additional attributes of the main model
name  : text
	The name of this app
object_type  : text
	(Value should be one of: APP)
path  : text
	The path within the repository
scenario_types  : insightapi2~dictionary_of_scenario_type
	The app's scenario types, mapped by type ID
url  : text
	The URL of this app
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_custom_scenario_types(myapp) then... 2. A app returned from a property of another model will be read-only; use the function insightapi2~copy_app to create an editable copy, e.g. myapp := insightapi2~copy_app(otherobj.originalapp) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~app_creation_response insightapi2~app_model insightapi2~app_or_folder_or_scenario insightapi2~dictionary_of_execution_mode insightapi2~dictionary_of_scenario_type insightapi2~execution_mode insightapi2~page_of_app insightapi2~scenario_type insightapi2~get_app insightapi2~update_app

insightapi2~app_creation_response  : record

app  : insightapi2~app
	The newly created app
messages  : list of text
	Information messages about the app creation which can be displayed to a user
url  : text
	The URL of newly created app
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app(myapp_creation_response) then... 2. A app_creation_response returned from a property of another model will be read-only; use the function insightapi2~copy_app_creation_response to create an editable copy, e.g. myapp_creation_response := insightapi2~copy_app_creation_response(otherobj.originalapp_creation_response) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~app insightapi2~create_app

insightapi2~app_execution_mode  : record

An execution mode for an app
app  : insightapi2~reference_app
	The app this execution mode belongs to
clears_input_data  : boolean
	Whether this execution mode causes input data to be cleared when it is run
description  : text
	The description of this execution mode
name  : text
	The name of this execution mode
preferred_execution_service  : insightapi2~reference_execution_service
	The execution service preferred by this execution mode
preferred_execution_service_name  : text
	The name of this execution mode's preferred service
priority  : integer
	The priority of this execution mode. A higher number indicates higher precedence, for example a priority of 100 will be prioritised over a priority of 1.
sends_progress  : boolean
	Whether the execution sends progress when this execution mode is run
threads  : integer
	The number of threads that this execution mode uses, or null for unlimited
unlimited_threads  : boolean
	Whether this execution mode places any restriction on number of threads
url  : text
	The URL of this execution mode
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app(myapp_execution_mode) then... 2. A app_execution_mode returned from a property of another model will be read-only; use the function insightapi2~copy_app_execution_mode to create an editable copy, e.g. myapp_execution_mode := insightapi2~copy_app_execution_mode(otherobj.originalapp_execution_mode) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~page_of_app_execution_mode insightapi2~reference_app insightapi2~reference_execution_service insightapi2~update_execution_mode

insightapi2~app_member  : record

A user who has access to the app.
authorities  : list of text
	The authorities granted to this app member
authority_groups  : list of insightapi2~reference_authority_group
	The authority groups granted to this app member
first_name  : text
	This app member's first name
id  : text
	The ID of this app member
last_name  : text
	This app member's last name
name  : text
	This app member's name
object_type  : text
	(Value should be one of: APP_MEMBER)
url  : text
	The URL of this app member
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_authorities(myapp_member) then... 2. A app_member returned from a property of another model will be read-only; use the function insightapi2~copy_app_member to create an editable copy, e.g. myapp_member := insightapi2~copy_app_member(otherobj.originalapp_member) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~page_of_app_member insightapi2~reference_authority_group

insightapi2~app_model  : record

data_version  : integer
	The model data version
name  : text
	The model name
version  : text
	The model version
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_data_version(myapp_model) then... 2. A app_model returned from a property of another model will be read-only; use the function insightapi2~copy_app_model to create an editable copy, e.g. myapp_model := insightapi2~copy_app_model(otherobj.originalapp_model) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~app

insightapi2~app_or_folder_or_scenario  : insightapi2~app or insightapi2~folder or insightapi2~scenario

See also

insightapi2~app insightapi2~folder insightapi2~scenario insightapi2~get_item_by_path

insightapi2~app_upgrade_request  : record

Used to provide options affecting how an upgrade request is treated
upgrade_type  : text
	Whether the upgrade app file should be considered to represent the full app or a partial. A full upgrade will replace the existing app with the app being uploaded, deleting any existing app content that is not in the app being uploaded. A partial upgrade will add and/or replace content in the existing app.app (Value should be one of: FULL,PARTIAL)
validate_model_name  : boolean
	Whether to validate that the new model name matches the previous model name
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_upgrade_type(myapp_upgrade_request) then... 2. A app_upgrade_request returned from a property of another model will be read-only; use the function insightapi2~copy_app_upgrade_request to create an editable copy, e.g. myapp_upgrade_request := insightapi2~copy_app_upgrade_request(otherobj.originalapp_upgrade_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~apps_id_body insightapi2~upgrade_app

insightapi2~app_upgrade_response  : record

messages  : list of text
	The messages describing the result of the upgrade
url  : text
	The URL of the upgraded app
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_messages(myapp_upgrade_response) then... 2. A app_upgrade_response returned from a property of another model will be read-only; use the function insightapi2~copy_app_upgrade_response to create an editable copy, e.g. myapp_upgrade_response := insightapi2~copy_app_upgrade_response(otherobj.originalapp_upgrade_response) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~upgrade_app

insightapi2~apps_id_body  : record

app_file  : insightapi2~file_data
	The app file
app_upgrade_request  : insightapi2~app_upgrade_request
	The AppUpgradeRequest to specify options for the upgrade.
validate_model_name  : boolean
	Whether to validate that the new model name matches the previous model name. Deprecated in favour of validateModelName on the AppUpgradeRequest.
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app_file(myapps_id_body) then... 2. A apps_id_body returned from a property of another model will be read-only; use the function insightapi2~copy_apps_id_body to create an editable copy, e.g. myapps_id_body := insightapi2~copy_apps_id_body(otherobj.originalapps_id_body) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~app_upgrade_request insightapi2~file_data

insightapi2~array  : record

Represents a map from a set of one or more index values, to a value
array  : insightapi2~dictionary
	The data in this array. The data is represented by a nested set of object maps. Leaves are the values, keys are the indices.
array_size  : integer
	The number of elements in this array
entity_name  : text
	The name of this array
filter_id  : text
	The id of the filter that was applied to this array, if present on the filter
scenario_id  : text
	The id of the scenario that owns this array
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_array(myarray) then... 2. A array returned from a property of another model will be read-only; use the function insightapi2~copy_array to create an editable copy, e.g. myarray := insightapi2~copy_array(otherobj.originalarray) 3. It is not possible to use a constructor to initialize this type within an expression. 4. If this structure is holding data retrieved from the webservice, numeric values in fields of type any will always be represented as real. If you are populating this type to send structure to the webservice, you may store numbers as either real or integer values in such fields.
See also	insightapi2~array_or_scalar_or_set insightapi2~dictionary

insightapi2~array_delta  : record

Details changes to a scenario array entity.
add  : list of insightapi2~array_element
	Array elements to add to the array entity.
remove  : list of list of any
	The keys of elements to remove from the array entity. Accepts Strings, Numbers and Booleans.
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_add(myarray_delta) then... 2. A array_delta returned from a property of another model will be read-only; use the function insightapi2~copy_array_delta to create an editable copy, e.g. myarray_delta := insightapi2~copy_array_delta(otherobj.originalarray_delta) 3. It is not possible to use a constructor to initialize this type within an expression. 4. If this structure is holding data retrieved from the webservice, numeric values in fields of type any will always be represented as real. If you are populating this type to send structure to the webservice, you may store numbers as either real or integer values in such fields.
See also	insightapi2~array_element insightapi2~entity_delta

insightapi2~array_element  : record

An element in an array entity.
key  : list of any
	The key of the element. Accepts strings, numbers and booleans.
value  : any
	The value of the element. Accepts strings, numbers and booleans.
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_key(myarray_element) then... 2. A array_element returned from a property of another model will be read-only; use the function insightapi2~copy_array_element to create an editable copy, e.g. myarray_element := insightapi2~copy_array_element(otherobj.originalarray_element) 3. It is not possible to use a constructor to initialize this type within an expression. 4. If this structure is holding data retrieved from the webservice, numeric values in fields of type any will always be represented as real. If you are populating this type to send structure to the webservice, you may store numbers as either real or integer values in such fields.
See also	insightapi2~array_delta

insightapi2~array_filter  : record

A filter that can be applied to an array, matching a subset of keys and values. This filter can specify for each index set the set elements that match the filter. When an array is filtered by the filter, the result is an array with only the values whose keys match the set elements of the filter for each index set. If an index set is not included in the filter then it is equivalent to including all set elements of that index set.
entity_name  : text
	The name of the entity this filter applies to
filter_id  : text
	The id of this filter
index_filters  : insightapi2~dictionary_of_list_of_any
	A map of index set name to the array of set elements to use when filtering the array. The index set name may be substituted with the ordinal of the index set within the array. (The first index set of the array has ordinal 0.)
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_entity_name(myarray_filter) then... 2. A array_filter returned from a property of another model will be read-only; use the function insightapi2~copy_array_filter to create an editable copy, e.g. myarray_filter := insightapi2~copy_array_filter(otherobj.originalarray_filter) 3. It is not possible to use a constructor to initialize this type within an expression. 4. If this structure is holding data retrieved from the webservice, numeric values in fields of type any will always be represented as real. If you are populating this type to send structure to the webservice, you may store numbers as either real or integer values in such fields.
See also	insightapi2~dictionary_of_list_of_any insightapi2~scenario_data_query

insightapi2~array_or_scalar_or_set  : insightapi2~array or insightapi2~scalar or insightapi2~set

See also

insightapi2~array insightapi2~scalar insightapi2~scenario_data insightapi2~set

insightapi2~attachment  : record

A file that is attached to an app or scenario
app  : insightapi2~reference_app
	The app that this attachment belongs to
content_url  : text
	The URL from which the contents of this attachment can be downloaded
description  : text
	A description of this attachment
filename  : text
	The file name of this attachment
hidden  : boolean
	Whether the attachment is hidden. This indicates the attachment is not for general user interaction
id  : text
	The ID of this attachment
last_modified  : text
	When the attachment contents were last modified
last_modified_by  : insightapi2~reference_user
	The user who last modified this attachment
name  : text
	The name of this attachment
object_type  : text
	(Value should be one of: ATTACHMENT)
parent  : insightapi2~reference_app_or_reference_scenario
	The parent of this attachment (either an app or a scenario). If the attachment is an app attachment, then the parent property will have the same value as the app property.
size  : real
	The size of this attachment in bytes
tags  : list of text
	The tags that are present on this attachment
url  : text
	The URL of this attachment
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app(myattachment) then... 2. A attachment returned from a property of another model will be read-only; use the function insightapi2~copy_attachment to create an editable copy, e.g. myattachment := insightapi2~copy_attachment(otherobj.originalattachment) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~page_of_attachment insightapi2~reference_app insightapi2~reference_app_or_reference_scenario insightapi2~reference_user insightapi2~get_app_attachment insightapi2~get_scenario_attachment insightapi2~update_app_attachment insightapi2~update_scenario_attachment insightapi2~upload_app_attachment insightapi2~upload_scenario_attachment

insightapi2~attachment_tag  : record

A label/tag which can be applied to one or more attachments depending on its properties.
description  : text
	A human-readable description for this tag
mandatory  : boolean
	Whether this tag must be present on at least one attachment belonging to the app or scenario
multi_file  : boolean
	Whether this tag can be present on multiple attachments
name  : text
	The unique name of this tag
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_description(myattachment_tag) then... 2. A attachment_tag returned from a property of another model will be read-only; use the function insightapi2~copy_attachment_tag to create an editable copy, e.g. myattachment_tag := insightapi2~copy_attachment_tag(otherobj.originalattachment_tag) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~page_of_attachment_tag

insightapi2~attachment_upload_request  : record

The attachment filename must conform to the following rules: The length must be between 1 and 255 characters (in UTF-16), it must not begin or end with a whitespace character, it must not contain any ISO Control Characters and it must not contain any of the characters \/?*: -<>"
attachment  : insightapi2~file_data
	The attachment to upload
overwrite  : boolean
	Whether to overwrite an existing attachment with the same filename or to create a new one with a new name
tag_name  : text
	The name of the tag to create this attachment with
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_attachment(myattachment_upload_request) then... 2. A attachment_upload_request returned from a property of another model will be read-only; use the function insightapi2~copy_attachment_upload_request to create an editable copy, e.g. myattachment_upload_request := insightapi2~copy_attachment_upload_request(otherobj.originalattachment_upload_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~file_data

insightapi2~attachments_files_body  : record

ids  : list of text
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_ids(myattachments_files_body) then... 2. A attachments_files_body returned from a property of another model will be read-only; use the function insightapi2~copy_attachments_files_body to create an editable copy, e.g. myattachments_files_body := insightapi2~copy_attachments_files_body(otherobj.originalattachments_files_body) 3. It is not possible to use a constructor to initialize this type within an expression.

insightapi2~attachments_files_body_1  : record

ids  : list of text
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_ids(myattachments_files_body_1) then... 2. A attachments_files_body_1 returned from a property of another model will be read-only; use the function insightapi2~copy_attachments_files_body_1 to create an editable copy, e.g. myattachments_files_body_1 := insightapi2~copy_attachments_files_body_1(otherobj.originalattachments_files_body_1) 3. It is not possible to use a constructor to initialize this type within an expression.

insightapi2~authority_group  : record

A group of authorities that can be assigned to user accounts.
authorities  : list of text
	The authorities in this group (Value should be one of: APP_ALL,APP_ATTACHMENT_EDIT,APP_ATTACHMENT_VIEW,APP_DELETE,APP_EDIT,APP_EXPORT,APP_NEW,DEVELOPER,DIRECT_DATA_VIEW,FOLDER_DELETE,FOLDER_EDIT,FOLDER_NEW,FOLDER_OWNER,FOLDER_SHARE,SCENARIO_ALL,SCENARIO_ATTACHMENT_EDIT,SCENARIO_DELETE,SCENARIO_EDIT,SCENARIO_EXEC,SCENARIO_NEW,SCENARIO_OWNER,SCENARIO_SHARE,SYS_IMPORTEXPORT,SYS_SERVER,SYS_SERVICES,SYS_USER)
custom_authorities  : list of insightapi2~custom_authority
	The custom authorities in this group
description  : text
	The description of this authority group
execution_services  : list of insightapi2~reference_execution_service
	The execution services permitted by this group
id  : text
	The ID of this authority group
name  : text
	The name of this authority group
object_type  : text
	(Value should be one of: AUTHORITY_GROUP)
url  : text
	The URL of this authority group
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_authorities(myauthority_group) then... 2. A authority_group returned from a property of another model will be read-only; use the function insightapi2~copy_authority_group to create an editable copy, e.g. myauthority_group := insightapi2~copy_authority_group(otherobj.originalauthority_group) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~custom_authority insightapi2~page_of_authority_group insightapi2~reference_execution_service insightapi2~create_authority_group insightapi2~get_authority_group insightapi2~update_authority_group

insightapi2~bearer_token_info  : record

Information about a bearer token
access_token_expiration_time  : text
	The expiration time of the token
cn  : text
	The user's common name
mail  : text
	The user's email address
uid  : text
	The user ID
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_access_token_expiration_time(mybearer_token_info) then... 2. A bearer_token_info returned from a property of another model will be read-only; use the function insightapi2~copy_bearer_token_info to create an editable copy, e.g. mybearer_token_info := insightapi2~copy_bearer_token_info(otherobj.originalbearer_token_info) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~get_bearer_token_info

insightapi2~bearer_token_request  : record

REST API credentials to generate a bearer token
client_id  : text
	The ID of client
max_age  : real
	The number of seconds until the generated token will expire
secret  : text
	The secret used to authorize the client
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_client_id(mybearer_token_request) then... 2. A bearer_token_request returned from a property of another model will be read-only; use the function insightapi2~copy_bearer_token_request to create an editable copy, e.g. mybearer_token_request := insightapi2~copy_bearer_token_request(otherobj.originalbearer_token_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~generate_bearer_token

insightapi2~compute_execution  : record

Details of how a compute job will be executed
execution_service  : text
	The execution service that should run this job
priority  : integer
	The priority of this job
threads  : integer
	The number of threads that this job requires. If set, must be between 1 and 256. This setting takes precedence over the XPRS_THREADS control.
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_execution_service(mycompute_execution) then... 2. A compute_execution returned from a property of another model will be read-only; use the function insightapi2~copy_compute_execution to create an editable copy, e.g. mycompute_execution := insightapi2~copy_compute_execution(otherobj.originalcompute_execution) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~compute_job insightapi2~compute_job_request

insightapi2~compute_job  : record

This object represents one job request submitted via the compute interface
app  : insightapi2~reference_app
	The app this job belongs to. This will always be the app named 'FICO Xpress Insight Compute'.
compute_job_type  : text
	The compute job type (Value should be one of: MOSEL,SOLVER)
dependency  : text
	Name of a dependency zip. Must match the name of a dependency uploaded as an app attachment to the compute app.
execution  : insightapi2~compute_execution
	Execution Service and threads to run the compute job on
id  : text
	The ID of this job
job_metrics_url  : text
	The URL of the metrics
model_status  : text
	The model status (Value should be one of: BREAK,ERROR,EXIT,INSTR,IOERR,LICERR,MATHERR,NA,NIFCT,NULL,OK,PROB,STOP,UNKNOWN,UNKN_PF,UNKN_SYS)
mosel  : insightapi2~compute_mosel
	Specify any mosel specific options if the type of the job is MOSEL
object_type  : text
	(Value should be one of: COMPUTE_JOB)
owner  : insightapi2~reference_user
	The user who owns this compute job
payload_url  : text
	The URL of the payload
result_url  : text
	The URL of the result
run_log_messages  : boolean
	True indicates that incremental run log messages should be sent to the web socket for the client that submitted this request
run_log_url  : text
	The URL of the run log
scenario  : insightapi2~reference_scenario
	The scenario this job relates to
solver  : insightapi2~compute_solver
	Specify any solver specific options if the type of the job is SOLVER
status  : text
	The status of this job (Value should be one of: CANCELLED,CANCELLING,COMPLETED,COMPLETING,DELETED,DELETING,EXECUTING,FAILED,INACTIVE,QUEUED)
url  : text
	The URL of this job
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app(mycompute_job) then... 2. A compute_job returned from a property of another model will be read-only; use the function insightapi2~copy_compute_job to create an editable copy, e.g. mycompute_job := insightapi2~copy_compute_job(otherobj.originalcompute_job) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~compute_execution insightapi2~compute_mosel insightapi2~compute_solver insightapi2~page_of_compute_job insightapi2~reference_app insightapi2~reference_scenario insightapi2~reference_user insightapi2~create_compute_job insightapi2~get_compute_job

insightapi2~compute_job_request  : record

A request to create a new compute job
compute_job_type  : text
	The compute job type (Value should be one of: MOSEL,SOLVER)
dependency  : text
	The name of a zip file to use for the compute job. If supplied, must match the name of a dependency uploaded to the compute app as an app attachment.
execution  : insightapi2~compute_execution
	Execution Service and threads to run the compute job on.
id  : text
	The ID of this compute job. This must be unique across all compute jobs. It must be between 1 and 60 characters and may only contain lower-case alphanumeric characters (a-z), underscores (_), dots (.) and hyphens (-).
log_level  : text
	Specify the log level for execution log output (Value should be one of: DEBUG,ERROR,INFO,WARN)
mosel  : insightapi2~compute_mosel
	Specify any mosel specific options if the type of the job is MOSEL
run_log_messages  : boolean
	True indicates that incremental run log messages should be sent to the web socket for the client that submitted this request.
solver  : insightapi2~compute_solver
	Specify any solver specific options if the type of the job is SOLVER
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_compute_job_type(mycompute_job_request) then... 2. A compute_job_request returned from a property of another model will be read-only; use the function insightapi2~copy_compute_job_request to create an editable copy, e.g. mycompute_job_request := insightapi2~copy_compute_job_request(otherobj.originalcompute_job_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~api_computejobs_body insightapi2~compute_execution insightapi2~compute_mosel insightapi2~compute_solver insightapi2~create_compute_job

insightapi2~compute_mosel  : record

Configuration for a Mosel compute job
parameters  : insightapi2~dictionary_of_text
	A map of Mosel model parameters
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_parameters(mycompute_mosel) then... 2. A compute_mosel returned from a property of another model will be read-only; use the function insightapi2~copy_compute_mosel to create an editable copy, e.g. mycompute_mosel := insightapi2~copy_compute_mosel(otherobj.originalcompute_mosel) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~compute_job insightapi2~compute_job_request insightapi2~dictionary_of_text

insightapi2~compute_solver  : record

Configuration for a Solver compute job
action  : text
	The solver action (Value should be one of: IIS,OPTIMIZE)
callbacks  : list of text
	Callbacks to invoke during the solving of a job of type SOLVER (requires integration with the Progress Events API) (Value should be one of: BARLOG,CUTLOG,GAPNOTIFY,GLOBALLOG,INTSOL,LPLOG)
controls  : insightapi2~dictionary_of_text
	A map of controls to values
flags  : list of text
	The flags to be applied during the solve (Value should be one of: BARRIER,DUAL,NETWORK,PRIMAL)
problem_type  : text
	The type of problem being solved. If not set, the solver will determine this based on the problem characteristics. (Value should be one of: LP,MIP)
results_to_include  : list of text
	The results to include in the output of this job (Value should be one of: ATTRIBUTES,BASIS,IIS,SAVE,SOLUTION)
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_action(mycompute_solver) then... 2. A compute_solver returned from a property of another model will be read-only; use the function insightapi2~copy_compute_solver to create an editable copy, e.g. mycompute_solver := insightapi2~copy_compute_solver(otherobj.originalcompute_solver) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~compute_job insightapi2~compute_job_request insightapi2~dictionary_of_text

insightapi2~custom_authority  : record

An authority defined by an app
name  : text
	The authority's name
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_name(mycustom_authority) then... 2. A custom_authority returned from a property of another model will be read-only; use the function insightapi2~copy_custom_authority to create an editable copy, e.g. mycustom_authority := insightapi2~copy_custom_authority(otherobj.originalcustom_authority) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~authority_group insightapi2~page_of_custom_authority

insightapi2~dashboard_query  : record

excluded_folder_ids  : list of text
	Folders to exclude from the query
root  : insightapi2~reference_app_or_reference_folder
	The starting point of the query
timestamp  : text
	Scenarios in the defined folder hierarchy will be checked to see whether they have been modified since this time
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_excluded_folder_ids(mydashboard_query) then... 2. A dashboard_query returned from a property of another model will be read-only; use the function insightapi2~copy_dashboard_query to create an editable copy, e.g. mydashboard_query := insightapi2~copy_dashboard_query(otherobj.originaldashboard_query) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~reference_app_or_reference_folder insightapi2~any_scenarios_modified_since

insightapi2~dashboard_response  : record

modified  : boolean
	Whether any of the scenarios have been modified
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_modified(mydashboard_response) then... 2. A dashboard_response returned from a property of another model will be read-only; use the function insightapi2~copy_dashboard_response to create an editable copy, e.g. mydashboard_response := insightapi2~copy_dashboard_response(otherobj.originaldashboard_response) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~any_scenarios_modified_since

insightapi2~entity_delta  : record

Details changes to a scenario entity.
array_delta  : insightapi2~array_delta
	The changes to apply to an array entity.
entity_name  : text
	The name of the scenario entity being changed.
set_delta  : insightapi2~set_delta
	The changes to apply to a set entity.
value  : any
	The new value for the entity. Accepts strings, numbers and booleans.
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_array_delta(myentity_delta) then... 2. A entity_delta returned from a property of another model will be read-only; use the function insightapi2~copy_entity_delta to create an editable copy, e.g. myentity_delta := insightapi2~copy_entity_delta(otherobj.originalentity_delta) 3. It is not possible to use a constructor to initialize this type within an expression. 4. If this structure is holding data retrieved from the webservice, numeric values in fields of type any will always be represented as real. If you are populating this type to send structure to the webservice, you may store numbers as either real or integer values in such fields.
See also	insightapi2~array_delta insightapi2~scenario_data_modification insightapi2~set_delta

insightapi2~error_detail  : record

An error detail
code  : text
	The unique code for this error
desc  : text
	A description of this error for client information, not intended for display to the end user
message  : text
	A message providing further information which may be displayed to the end user
target  : text
	An identifier to help the client locate the error. Typically a JSON property name.
timestamp  : text
	When the error was first detected
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_code(myerror_detail) then... 2. A error_detail returned from a property of another model will be read-only; use the function insightapi2~copy_error_detail to create an editable copy, e.g. myerror_detail := insightapi2~copy_error_detail(otherobj.originalerror_detail) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~outer_error

insightapi2~error_response  : record

An error response containing fault or error information
error  : insightapi2~outer_error
	The top level error
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_error(myerror_response) then... 2. A error_response returned from a property of another model will be read-only; use the function insightapi2~copy_error_response to create an editable copy, e.g. myerror_response := insightapi2~copy_error_response(otherobj.originalerror_response) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~outer_error insightapi2~any_scenarios_modified_since insightapi2~cancel_job insightapi2~cancel_jobs insightapi2~check_mirror_health insightapi2~create_app insightapi2~create_authority_group insightapi2~create_compute_job insightapi2~create_execution_service insightapi2~create_execution_worker insightapi2~create_folder insightapi2~create_job insightapi2~create_or_update_execution_worker_mapping insightapi2~create_scenario insightapi2~create_user insightapi2~delete_app insightapi2~delete_app_attachment insightapi2~delete_app_attachments insightapi2~delete_compute_job insightapi2~delete_execution_service insightapi2~delete_execution_worker insightapi2~delete_execution_worker_mapping insightapi2~delete_folder insightapi2~delete_scenario insightapi2~delete_scenario_attachment insightapi2~delete_scenario_attachments insightapi2~delete_user insightapi2~dismiss_portations insightapi2~get_app insightapi2~get_app_attachment insightapi2~get_app_attachment_file insightapi2~get_app_attachment_tags insightapi2~get_app_attachments insightapi2~get_app_children insightapi2~get_app_members insightapi2~get_app_message_file insightapi2~get_app_model_schema insightapi2~get_authority_group insightapi2~get_compute_job insightapi2~get_compute_message_file insightapi2~get_execution_service insightapi2~get_execution_worker insightapi2~get_execution_worker_mapping insightapi2~get_export insightapi2~get_export_file insightapi2~get_folder insightapi2~get_folder_children insightapi2~get_import insightapi2~get_item_by_path insightapi2~get_job insightapi2~get_job_metrics insightapi2~get_job_run_log insightapi2~get_multiple_app_attachment_files insightapi2~get_multiple_scenario_attachment_files insightapi2~get_scenario insightapi2~get_scenario_attachment insightapi2~get_scenario_attachment_file insightapi2~get_scenario_attachments insightapi2~get_scenario_data insightapi2~get_scenario_job_metrics insightapi2~get_scenario_run_log insightapi2~get_user insightapi2~modify_scenario_data insightapi2~move_to_app_root insightapi2~move_to_folder insightapi2~perform_export insightapi2~perform_import insightapi2~send_message_to_job insightapi2~update_app insightapi2~update_app_attachment insightapi2~update_authority_group insightapi2~update_execution_mode insightapi2~update_execution_service insightapi2~update_execution_worker insightapi2~update_folder insightapi2~update_scenario insightapi2~update_scenario_attachment insightapi2~update_user insightapi2~upgrade_app insightapi2~upload_app_attachment insightapi2~upload_scenario_attachment

insightapi2~execution_mode  : record

A standard or custom mode by which a job is executed which provides additional control by either altering the code path of the model itself or routing the job to particular execution services
clears_input_data  : boolean
	Whether this execution mode causes input data to be cleared when it is run
description  : text
	The description of this execution mode
name  : text
	The name of this execution mode
priority  : integer
	The priority of this execution mode. A higher number indicates higher precedence, for example a priority of 100 will be prioritised over a priority of 1.
sends_progress  : boolean
	Whether the execution sends progress when this execution mode is run
threads  : integer
	The number of threads that this execution mode uses, or null for unlimited
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_clears_input_data(myexecution_mode) then... 2. A execution_mode returned from a property of another model will be read-only; use the function insightapi2~copy_execution_mode to create an editable copy, e.g. myexecution_mode := insightapi2~copy_execution_mode(otherobj.originalexecution_mode) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~app insightapi2~job

insightapi2~execution_service  : record

An execution service running on an execution worker
default  : boolean
	Whether this service is the default for models which do not nominate a specific service
enabled  : boolean
	Whether this service is enabled
id  : text
	The ID of this execution service
name  : text
	The name of this execution service
object_type  : text
	(Value should be one of: EXECUTION_SERVICE)
restricted  : boolean
	Whether this service is restricted to certain users via user authorities
url  : text
	The URL of this execution service
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_default(myexecution_service) then... 2. A execution_service returned from a property of another model will be read-only; use the function insightapi2~copy_execution_service to create an editable copy, e.g. myexecution_service := insightapi2~copy_execution_service(otherobj.originalexecution_service) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~page_of_execution_service insightapi2~create_execution_service insightapi2~get_execution_service insightapi2~update_execution_service

insightapi2~execution_service_creation_request  : record

A request to create a new execution service
default  : boolean
	Whether this service is the default for models which do not nominate a specific service
enabled  : boolean
	Whether this service is enabled
name  : text
	The name of the new service
restricted  : boolean
	Whether this service is restricted to certain users via user authorities
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_default(myexecution_service_creation_request) then... 2. A execution_service_creation_request returned from a property of another model will be read-only; use the function insightapi2~copy_execution_service_creation_request to create an editable copy, e.g. myexecution_service_creation_request := insightapi2~copy_execution_service_creation_request(otherobj.originalexecution_service_creation_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~create_execution_service

insightapi2~execution_service_worker_mapping  : record

enabled  : boolean
	Whether this mapping is enabled
job_capacity  : integer
	The maximum number of jobs that can run at once
object_type  : text
	The type of reference (Value should be one of: EXECUTION_SERVICE_WORKER_MAPPING)
service  : insightapi2~reference_execution_service
	A reference to the execution service
thread_capacity  : integer
	The maximum number of threads that can run at once
unlimited_jobs  : boolean
	Whether this mapping places any restriction on the number of jobs
unlimited_threads  : boolean
	Whether this mapping places any restriction on the number of threads
url  : text
	The URL of this mapping
worker  : insightapi2~reference_execution_worker
	A reference to the execution worker
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_enabled(myexecution_service_worker_mapping) then... 2. A execution_service_worker_mapping returned from a property of another model will be read-only; use the function insightapi2~copy_execution_service_worker_mapping to create an editable copy, e.g. myexecution_service_worker_mapping := insightapi2~copy_execution_service_worker_mapping(otherobj.originalexecution_service_worker_mapping) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~page_of_execution_service_worker_mapping insightapi2~reference_execution_service insightapi2~reference_execution_worker insightapi2~create_or_update_execution_worker_mapping insightapi2~get_execution_worker_mapping

insightapi2~execution_worker  : record

A worker which executes jobs
enabled  : boolean
	Whether this worker is enabled
id  : text
	The ID of this execution worker
job_capacity  : integer
	The maximum number of jobs that this worker can run at once
name  : text
	The name of this execution worker
object_type  : text
	(Value should be one of: EXECUTION_WORKER)
state  : insightapi2~execution_worker_state
	The current state of this worker
thread_capacity  : integer
	The maximum number of threads that this worker can run at once
unlimited_threads  : boolean
	Whether this worker has unlimited thread capacity
url  : text
	The URL of this execution worker
version  : text
	The version of this worker
worker_url  : text
	The URL that this worker is available on
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_enabled(myexecution_worker) then... 2. A execution_worker returned from a property of another model will be read-only; use the function insightapi2~copy_execution_worker to create an editable copy, e.g. myexecution_worker := insightapi2~copy_execution_worker(otherobj.originalexecution_worker) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~execution_worker_state insightapi2~page_of_execution_worker insightapi2~create_execution_worker insightapi2~get_execution_worker insightapi2~update_execution_worker

insightapi2~execution_worker_creation_request  : record

A request to create a new execution worker
enabled  : boolean
	Whether this worker is enabled
job_capacity  : integer
	The maximum number of jobs that this worker can run at once
name  : text
	The name for this worker
thread_capacity  : integer
	The maximum number of threads that this worker can run at once
unlimited_threads  : boolean
	Whether this worker has unlimited thread capacity
worker_url  : text
	The URL that this worker is available on
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_enabled(myexecution_worker_creation_request) then... 2. A execution_worker_creation_request returned from a property of another model will be read-only; use the function insightapi2~copy_execution_worker_creation_request to create an editable copy, e.g. myexecution_worker_creation_request := insightapi2~copy_execution_worker_creation_request(otherobj.originalexecution_worker_creation_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~create_execution_worker

insightapi2~execution_worker_state  : record

message  : text
	A message containing information about this worker's status
status  : text
	The current status of this worker (Value should be one of: OFFLINE,ONLINE)
status_last_modified  : text
	When this worker's status was last modified
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_message(myexecution_worker_state) then... 2. A execution_worker_state returned from a property of another model will be read-only; use the function insightapi2~copy_execution_worker_state to create an editable copy, e.g. myexecution_worker_state := insightapi2~copy_execution_worker_state(otherobj.originalexecution_worker_state) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~execution_worker

insightapi2~export  : record

Contains the status and location of an export.
dismissed  : boolean
	True indicates this portation has been dismissed by the owner.
download_url  : text
	The download url of this export
error_messages  : list of text
	The error messages produced by this portation
filename  : text
	The filename for this portation
finished  : text
	When this portation finished
id  : text
	The ID of this export
include_folders_and_scenarios  : boolean
	The filter to indicate whether folders and scenario are included as part of this export or not. This is applicable only for an app export
info_messages  : list of text
	The info messages produced by this portation
name  : text
	The name of this export
object_type  : text
	(Value should be one of: EXPORT)
owner  : insightapi2~reference_user
	The user that owns this portation
parent  : insightapi2~reference_export_or_reference_import
	The parent of this portation. This is populated when this portation belongs to another. For example when importing an insight file which contains many apps then each app import will be parented by the original import portation.
path  : text
	The path for this export relative to the configured portation directory.
reference  : insightapi2~reference_app_or_reference_folder_or_reference_scenario
	The reference of the item (app, folder or scenario) being ported
started  : text
	When this portation started
status  : text
	The status of this portation (Value should be one of: ERROR,MIGRATING,PORTING,QUEUED,SUCCESS)
url  : text
	The URL of this export
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_dismissed(myexport) then... 2. A export returned from a property of another model will be read-only; use the function insightapi2~copy_export to create an editable copy, e.g. myexport := insightapi2~copy_export(otherobj.originalexport) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~reference_app_or_reference_folder_or_reference_scenario insightapi2~reference_export_or_reference_import insightapi2~reference_user insightapi2~get_export insightapi2~perform_export

insightapi2~export_request  : record

include_folders_and_scenarios  : boolean
	Filter to indicate whether to include folders and scenario as part of an app export. This is not required for a folder or a scenario export
source  : insightapi2~reference_app_or_reference_folder_or_reference_scenario
	Reference to the item (app, folder or scenario) to be exported
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_include_folders_and_scenarios(myexport_request) then... 2. A export_request returned from a property of another model will be read-only; use the function insightapi2~copy_export_request to create an editable copy, e.g. myexport_request := insightapi2~copy_export_request(otherobj.originalexport_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~reference_app_or_reference_folder_or_reference_scenario insightapi2~perform_export

insightapi2~folder  : record

Represents a folder in the app folder hierarchy. See the wider product documentation for more information on folders
app  : insightapi2~reference_app
	The app that owns this folder
id  : text
	The ID of this folder
name  : text
	The name of this folder
object_type  : text
	(Value should be one of: FOLDER)
owner  : insightapi2~reference_user
	The user that owns this folder
parent  : insightapi2~reference_app_or_reference_folder
	The parent of this folder
path  : text
	The path within the repository
share_status  : text
	The share status of this folder (Value should be one of: FULLACCESS,PRIVATE,READONLY)
url  : text
	The URL of this folder
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app(myfolder) then... 2. A folder returned from a property of another model will be read-only; use the function insightapi2~copy_folder to create an editable copy, e.g. myfolder := insightapi2~copy_folder(otherobj.originalfolder) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~app_or_folder_or_scenario insightapi2~folder_or_scenario insightapi2~reference_app insightapi2~reference_app_or_reference_folder insightapi2~reference_user insightapi2~create_folder insightapi2~get_folder insightapi2~update_folder

insightapi2~folder_creation_request  : record

A request to create a new folder
name  : text
	The name for the folder
parent  : insightapi2~reference_app_or_reference_folder
	The app or folder to create this folder under
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_name(myfolder_creation_request) then... 2. A folder_creation_request returned from a property of another model will be read-only; use the function insightapi2~copy_folder_creation_request to create an editable copy, e.g. myfolder_creation_request := insightapi2~copy_folder_creation_request(otherobj.originalfolder_creation_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~reference_app_or_reference_folder insightapi2~create_folder

insightapi2~folder_or_scenario  : insightapi2~folder or insightapi2~scenario

See also

insightapi2~folder insightapi2~page_of_folder_or_scenario insightapi2~scenario insightapi2~move_to_app_root insightapi2~move_to_folder

insightapi2~import  : record

Contains the status and location of an import.
dismissed  : boolean
	True indicates this portation has been dismissed by the owner.
error_messages  : list of text
	The error messages produced by this portation
filename  : text
	The filename for this portation
finished  : text
	When this portation finished
id  : text
	The ID of this import
import_type  : text
	Type of import to perform with the supplied file. (Value should be one of: APP,FOLDER_OR_SCENARIO,REPOSITORY)
info_messages  : list of text
	The info messages produced by this portation
name  : text
	The name of this import
object_type  : text
	(Value should be one of: IMPORT)
owner  : insightapi2~reference_user
	The user that owns this portation
parent  : insightapi2~reference_export_or_reference_import
	The parent of this portation. This is populated when this portation belongs to another. For example when importing an insight file which contains many apps then each app import will be parented by the original import portation.
reference  : insightapi2~reference_app_or_reference_folder_or_reference_scenario
	The reference of the item (app, folder or scenario) being ported
security  : text
	Controls the security of imported assets (Value should be one of: ORIGINAL,PRIVATE)
started  : text
	When this portation started
status  : text
	The status of this portation (Value should be one of: ERROR,MIGRATING,PORTING,QUEUED,SUCCESS)
target  : insightapi2~reference_app_or_reference_folder
	The reference to the parent of the imported scenario or folder. This will not be populated for an app import
url  : text
	The URL of this import
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_dismissed(myimport) then... 2. A import returned from a property of another model will be read-only; use the function insightapi2~copy_import to create an editable copy, e.g. myimport := insightapi2~copy_import(otherobj.originalimport) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~reference_app_or_reference_folder insightapi2~reference_app_or_reference_folder_or_reference_scenario insightapi2~reference_export_or_reference_import insightapi2~reference_user insightapi2~get_import insightapi2~perform_import

insightapi2~import_upload_request  : record

import_type  : text
	Type of import to perform with the supplied file. (Value should be one of: APP,FOLDER_OR_SCENARIO,REPOSITORY)
security  : text
	Controls the security of imported assets (Value should be one of: ORIGINAL,PRIVATE)
target  : insightapi2~reference_app_or_reference_folder
	The reference to the target item (app or folder) to which a folder or a scenario is to be imported. This will not be needed for an app or repository import
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_import_type(myimport_upload_request) then... 2. A import_upload_request returned from a property of another model will be read-only; use the function insightapi2~copy_import_upload_request to create an editable copy, e.g. myimport_upload_request := insightapi2~copy_import_upload_request(otherobj.originalimport_upload_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~portations_imports_body insightapi2~reference_app_or_reference_folder insightapi2~perform_import

insightapi2~inner_error  : record

More specific error information
code  : text
	The unique code for this error
desc  : text
	A description of this error for client information, not intended for display to the end user
inner_error  : insightapi2~inner_error
	More specific error information
message  : text
	A message providing further information which may be displayed to the end user
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_code(myinner_error) then... 2. A inner_error returned from a property of another model will be read-only; use the function insightapi2~copy_inner_error to create an editable copy, e.g. myinner_error := insightapi2~copy_inner_error(otherobj.originalinner_error) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~inner_error insightapi2~outer_error

insightapi2~job  : record

The state of a job
app  : insightapi2~reference_app
	The app this job belongs to
created  : text
	When the job was created
duration  : real
	The duration of this job. This is only present when the job is finished
execution_attempts  : integer
	The number of attempts to execute this job
execution_id  : text
	The current execution ID for this job. This changes if a job is rescheduled and executed again
execution_mode  : insightapi2~execution_mode
	The execution mode this job will run in
execution_service  : insightapi2~reference_execution_service
	The execution service for this job
execution_worker  : insightapi2~reference_execution_worker
	The execution worker for this job
finished  : text
	When the job was finished
id  : text
	The ID of this job state
model_status  : text
	The model status (Value should be one of: BREAK,ERROR,EXIT,INSTR,IOERR,LICERR,MATHERR,NA,NIFCT,NULL,OK,PROB,STOP,UNKNOWN,UNKN_PF,UNKN_SYS)
name  : text
	The name of this job state
object_type  : text
	(Value should be one of: JOB_STATE)
objective  : real
	The objective
owner  : insightapi2~reference_user
	The user who owns this job
scenario  : insightapi2~reference_scenario
	The scenario this job belongs to
solver_status  : text
	The solver status (Value should be one of: INFEASIBLE,NA,OPTIMAL,OTHER,SOLUTION,UNBOUNDED,UNFINISHED,UNKNOWN)
started  : text
	When the job was started
status  : text
	The status of this job (Value should be one of: CANCELLED,CANCELLING,COMPLETED,COMPLETING,DELETED,DELETING,EXECUTING,FAILED,INACTIVE,QUEUED)
url  : text
	The URL of this job state
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app(myjob) then... 2. A job returned from a property of another model will be read-only; use the function insightapi2~copy_job to create an editable copy, e.g. myjob := insightapi2~copy_job(otherobj.originaljob) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~execution_mode insightapi2~page_of_job insightapi2~reference_app insightapi2~reference_execution_service insightapi2~reference_execution_worker insightapi2~reference_scenario insightapi2~reference_user insightapi2~cancel_job insightapi2~create_job insightapi2~get_job

insightapi2~job_creation_request  : record

A request to create a new job
execution_mode  : text
	The execution mode (standard or user-defined) of the job
scenario  : insightapi2~reference_scenario
	The scenario to create the job for
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_execution_mode(myjob_creation_request) then... 2. A job_creation_request returned from a property of another model will be read-only; use the function insightapi2~copy_job_creation_request to create an editable copy, e.g. myjob_creation_request := insightapi2~copy_job_creation_request(otherobj.originaljob_creation_request) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~reference_scenario insightapi2~create_job

insightapi2~job_message  : record

A message sent from a client to an executing job. Messages are used to send commands to the model.
execution_id  : text
	The execution id of the job to send a message to
message  : text
	The message to send to the model
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_execution_id(myjob_message) then... 2. A job_message returned from a property of another model will be read-only; use the function insightapi2~copy_job_message to create an editable copy, e.g. myjob_message := insightapi2~copy_job_message(otherobj.originaljob_message) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~send_message_to_job

insightapi2~job_metrics  : record

Metrics for a job that is either executing or has completed execution. Job metrics consist of 3 distinct stages that a job progresses through in order to complete execution.
duration  : real
	The current duration of this job
execution  : insightapi2~job_stage
	The execution stage
queued  : insightapi2~job_stage
	The queued stage
started  : text
	When this job started
worker  : insightapi2~job_stage
	The worker stage
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_duration(myjob_metrics) then... 2. A job_metrics returned from a property of another model will be read-only; use the function insightapi2~copy_job_metrics to create an editable copy, e.g. myjob_metrics := insightapi2~copy_job_metrics(otherobj.originaljob_metrics) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~job_stage insightapi2~get_job_metrics insightapi2~get_scenario_job_metrics

insightapi2~job_phase  : record

A phase of a job stage. Each phase may have one or more phase metrics.
duration  : real
	The current duration of this job phase
metrics  : insightapi2~dictionary_of_job_phase_metric
	This phase's metrics, keyed by name
name  : text
	The name of this phase
started  : text
	When this phase started
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_duration(myjob_phase) then... 2. A job_phase returned from a property of another model will be read-only; use the function insightapi2~copy_job_phase to create an editable copy, e.g. myjob_phase := insightapi2~copy_job_phase(otherobj.originaljob_phase) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~dictionary_of_job_phase_metric insightapi2~job_phase_metric insightapi2~job_stage

insightapi2~job_phase_metric  : record

A metric of a job phase
count  : integer
	The count of this phase metric
data_size  : real
	The size of this phase metric
duration  : real
	The current duration of this job phase metric
name  : text
	The name of this phase metric
started  : text
	When this phase metric started
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_count(myjob_phase_metric) then... 2. A job_phase_metric returned from a property of another model will be read-only; use the function insightapi2~copy_job_phase_metric to create an editable copy, e.g. myjob_phase_metric := insightapi2~copy_job_phase_metric(otherobj.originaljob_phase_metric) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~job_phase

insightapi2~job_query  : record

scenario_ids  : list of text
	The IDs of the scenarios to find jobs for
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_scenario_ids(myjob_query) then... 2. A job_query returned from a property of another model will be read-only; use the function insightapi2~copy_job_query to create an editable copy, e.g. myjob_query := insightapi2~copy_job_query(otherobj.originaljob_query) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~query_jobs

insightapi2~job_stage  : record

A stage of a job metric. A stage is sub-divided into phases.
duration  : real
	The current duration of this job stage
name  : text
	The name of this job stage
phases  : list of insightapi2~job_phase
	This stage's phases
started  : text
	When this stage started
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_duration(myjob_stage) then... 2. A job_stage returned from a property of another model will be read-only; use the function insightapi2~copy_job_stage to create an editable copy, e.g. myjob_stage := insightapi2~copy_job_stage(otherobj.originaljob_stage) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~job_metrics insightapi2~job_phase

insightapi2~list_of_ids  : record

A list of UUIDs
ids  : list of text
	The IDs
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_ids(mylist_of_ids) then... 2. A list_of_ids returned from a property of another model will be read-only; use the function insightapi2~copy_list_of_ids to create an editable copy, e.g. mylist_of_ids := insightapi2~copy_list_of_ids(otherobj.originallist_of_ids) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~delete_app_attachments insightapi2~delete_scenario_attachments

insightapi2~mirror_configuration_health  : record

Configuration details for display in health checks
database_url  : text
	The configured mirror database connection string
max_idle_time  : integer
	The configured maximum time, in seconds, the data for a scenario will live before it is evicted
min_time_to_live  : integer
	The configured minimum time, in seconds, the data for a scenario will live before being eligible for eviction
target_capacity  : integer
	The mirror capacity the system will attempt to maintain
username  : text
	The configured database username
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_database_url(mymirror_configuration_health) then... 2. A mirror_configuration_health returned from a property of another model will be read-only; use the function insightapi2~copy_mirror_configuration_health to create an editable copy, e.g. mymirror_configuration_health := insightapi2~copy_mirror_configuration_health(otherobj.originalmirror_configuration_health) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~mirror_health

insightapi2~mirror_health  : record

Provides health check information relating to the mirror configuration
configuration  : insightapi2~mirror_configuration_health
	Holds mirror configuration information
health_checks  : insightapi2~dictionary_of_visualization_health_check
	A map of VisualizationHealthCheck objects detailing the health of the mirror configuration
status  : text
	The combined status for the mirror health checks. (Value should be one of: FAIL,PASS,SKIPPED,WARN)
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_configuration(mymirror_health) then... 2. A mirror_health returned from a property of another model will be read-only; use the function insightapi2~copy_mirror_health to create an editable copy, e.g. mymirror_health := insightapi2~copy_mirror_health(otherobj.originalmirror_health) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~dictionary_of_visualization_health_check insightapi2~mirror_configuration_health insightapi2~visualization_health_check insightapi2~check_mirror_health

insightapi2~model_entity  : record

Represents one data entity and its attributes in the data schema of the app.
abbreviated_name  : text
	The abbreviated name of this entity
alias  : text
	The alias of this entity
always_hidden  : boolean
	Indicates whether this entity is always hidden
constant  : boolean
	Indicates whether this entity is a constant
data_type  : text
	The data type of this entity (Value should be one of: ARRAY,BOOLEAN,CONSTRAINT,CONSTRAINT_TYPE,DECISION_VARIABLE,INTEGER,MODEL,PROBLEM_STATUS,REAL,SET,STRING,UNSUPPORTED,VARIABLE_TYPE)
element_type  : text
	The type of elements this array or set contains (Value should be one of: ARRAY,BOOLEAN,CONSTRAINT,CONSTRAINT_TYPE,DECISION_VARIABLE,INTEGER,MODEL,PROBLEM_STATUS,REAL,SET,STRING,UNSUPPORTED,VARIABLE_TYPE)
format  : text
	The formatting of this entity
hidden  : boolean
	Indicates whether this entity is hidden
index_grouping  : boolean
	Indicates whether this entity is used to group an index
index_groupings  : list of text
	The index groupings for this set
index_sets  : list of text
	The name of the index sets that index this array
labels_entity  : boolean
	Indicates whether this entity is used as the labels for another entity
labels_entity_name  : text
	The name of the entity that holds the labels for this entity
management_type  : text
	Indicates whether entity is part of the input or the results data (Value should be one of: DEFAULT,IGNORE,INPUT,RESULT)
name  : text
	The name of this entity
update_strategy  : text
	The update strategy of this entity (Value should be one of: AFTER_EXECUTION,DEFAULT,PROGRESS)
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_abbreviated_name(mymodel_entity) then... 2. A model_entity returned from a property of another model will be read-only; use the function insightapi2~copy_model_entity to create an editable copy, e.g. mymodel_entity := insightapi2~copy_model_entity(otherobj.originalmodel_entity) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~model_schema

insightapi2~model_schema  : record

The data schema of the scenarios in the app, derived from the model.
app  : insightapi2~reference_app
	The app that owns this schema
entities  : insightapi2~dictionary_of_model_entity
	The entities defined by this schema, keyed by entity name
id  : text
	The ID of this model schema
name  : text
	The name of this model schema
object_type  : text
	(Value should be one of: MODEL_SCHEMA)
url  : text
	The URL of this model schema
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_app(mymodel_schema) then... 2. A model_schema returned from a property of another model will be read-only; use the function insightapi2~copy_model_schema to create an editable copy, e.g. mymodel_schema := insightapi2~copy_model_schema(otherobj.originalmodel_schema) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~dictionary_of_model_entity insightapi2~model_entity insightapi2~reference_app insightapi2~get_app_model_schema

insightapi2~outer_error  : record

The top level error
code  : text
	The unique code for this error (Value should be one of: FICO-Platform-Http-400,FICO-Platform-Http-404,FICO-Platform-Http-409,FICO-Platform-Http-413,FICO-Platform-Http-422,FICO-Platform-Http-423,FICO-Platform-Http-429,FICO-Platform-Http-500,FICO-Platform-Http-502,FICO-Platform-Http-503)
desc  : text
	A description of this error for client information, not intended for display to the end user
details  : list of insightapi2~error_detail
	Details about specific errors that led to this reported error
inner_error  : insightapi2~inner_error
	More specific error information
message  : text
	A message providing further information which may be displayed to the end user
parent_id  : text
	An OpenTracing parent-span ID
span_id  : text
	An OpenTracing span ID
timestamp  : text
	When the error was first detected
trace_id  : text
	An OpenTracing trace ID
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_code(myouter_error) then... 2. A outer_error returned from a property of another model will be read-only; use the function insightapi2~copy_outer_error to create an editable copy, e.g. myouter_error := insightapi2~copy_outer_error(otherobj.originalouter_error) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~error_detail insightapi2~error_response insightapi2~inner_error

insightapi2~page_of_app  : record

A page containing a subset of content which can be paginated through
content  : list of insightapi2~app
	The items in this page of results
first  : boolean
	Whether this is the first page
last  : boolean
	Whether this is the last page
number  : integer
	The page number, starting at 0
number_of_elements  : integer
	The number of elements in this page of results
size  : integer
	The number of results per page
sort  : insightapi2~sort
	The sort order applied to the results
total_elements  : integer
	The total number of elements in all the pages
total_pages  : integer
	The total number of pages
Notes	1. For each property of the type, there is a has function to check if it is populated, e.g. if has_content(mypage_of_app) then... 2. A page_of_app returned from a property of another model will be read-only; use the function insightapi2~copy_page_of_app to create an editable copy, e.g. mypage_of_app := insightapi2~copy_page_of_app(otherobj.originalpage_of_app) 3. It is not possible to use a constructor to initialize this type within an expression.
See also	insightapi2~app insightapi2~sort insightapi2~get_apps