Insight 4 REST API
Introduction
REST Resources
This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:
- AttachmentEditorResource
- AuthenticationResource
- ConfigurationResource
- DebuggerResource
- ExecutionResource
- FolderResource
- PingResource
- ProjectResource
- RepositoryResource
- ScenarioResource
- UserResource
- VirtualScenarioGroupResource
Data Model
All endpoints act on a common set of data. The data can be represented with difference media (i.e. "MIME") types, depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.
This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.
Namespace "ns0"
Namespace URI: | (default namespace) |
Data Elements
Data Types
Namespace "apiv1"
Namespace URI: | http://fico.com/xpress/insight/rest/v1 |
Data Elements
- applicationFeature
- array
- arrayElement
- arrayFilter
- attachment
- attachmentEditorDetails
- attachmentEditorMetadata
- attachmentEditorProperties
- attachmentError
- attachmentExportParams
- attachmentImportParams
- attachmentWithEditorData
- debugSessionInfo
- editor
- executionMode
- executionRequest
- executionStatus
- folder
- messages
- modelEntity
- modelSchema
- ping
- project
- projectImportFormResult
- projectImportResult
- projectUpdateResult
- projectUser
- queryArrayOptions
- reference
- referenceList
- scalar
- scenario
- scenarioCreateParams
- scenarioData
- scenarioDataQuery
- scenarioImportFormResult
- scenarioImportResult
- scenarioLite
- scenarioSolutionData
- scenarioSummaryData
- scenarioType
- set
- setDelta
- tableauWorkbook
- user
- view
- virtualScenarioGroup
- webServiceBeanList
- workbookPublishResult
Data Types
- applicationFeature
- array
- arrayElement
- arrayFilter
- attachment
- attachmentEditorDetails
- attachmentEditorMetadata
- attachmentEditorProperties
- attachmentError
- attachmentExportParams
- attachmentImportParams
- attachmentStorageAction
- attachmentWithEditorData
- debugSessionInfo
- editor
- entityValue
- executionMode
- executionRequest
- executionStatus
- folder
- jobType
- messages
- modelEntity
- modelSchema
- objectType
- ping
- project
- projectImportFormResult
- projectImportResult
- projectUpdateResult
- projectUser
- queryArrayOptions
- reference
- referenceList
- scalar
- scenario
- scenarioCreateParams
- scenarioData
- scenarioDataQuery
- scenarioImportFormResult
- scenarioImportResult
- scenarioLite
- scenarioSolutionData
- scenarioSummaryData
- scenarioType
- set
- setDelta
- simpleReference
- tableauParameter
- tableauWorkbook
- user
- view
- viewType
- virtualScenarioGroup
- webServiceBean
- webServiceBeanList
- workbookPublishResult
© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.