SIL Insight User guide
Prerequisites
This integration needs Insight app pre-installed.
Functions
- insight_deleteObject — Deletes an insight object. Returns true if the deletion succeeded, false otherwise.
- insight_findObjects — Runs a IQL over insight and returns all objects found.
- insight_getAttribByName — Gets an attribute by name, and returns the string representation for it.
- insight_getIssuesForObject — Retrieves all issues which are linked to that object.
- insight_getObject — Returns the type of the attribute, either by id or by objectTypeId and key.
- insight_getObjectAttrType — Returns the type of the attribute, either by id or by objectTypeId and key.
- insight_getObjectType — Returns the object type by id.
- insight_getObjectsForIssue — Retrieves all the objects linked to that issue.
- insight_saveObject — Saves an object into the insight schema.
- insight_setAttribByName — Sets an attribute by name, but does not save the object.
Types
Here is a list of predefined structures that are used throughout Power Scripts with specific functions for Insight.
Name | Fields | Fields type | Notes |
|---|---|---|---|
IReferenceType | id | integer |
|
name | string |
| |
description | string |
| |
color | string |
| |
objectSchemaId | integer |
| |
removable | boolean |
| |
IObjectType | id | integer |
|
name | string |
| |
created | date |
| |
updated | date |
| |
description | string |
| |
position | integer |
| |
objectSchemaId | integer |
| |
parentObjectTypeId | integer |
| |
abstractObjectType | boolean |
| |
IObjectAttrType | id | integer |
|
name | string |
| |
created | date |
| |
updated | date |
| |
description | string |
| |
position | integer |
| |
minCardinality | integer |
| |
maxCardinality | integer |
| |
objectTypeId | integer |
| |
iql | string |
| |
suffix | string |
| |
regex | string |
| |
typeValue | string |
| |
additionalValue | string |
| |
options | string |
| |
multiTypeValues | string[] |
| |
typeId | integer |
| |
defaultTypeId | integer |
| |
refObjectTypeId | integer |
| |
refObjectType | IReferenceType |
| |
IObject | id | integer |
|
key | string |
| |
created | date |
| |
updated | date |
| |
label | string |
| |
objectTypeId | integer |
| |
objectAttributes | IObjectAttr[] | Array of IObjectAttr types | |
IObjectAttr | id | integer |
|
objectId | integer |
| |
objectAttrTypeId | integer |
| |
objectAttrValues | IObjectAttrValue[] | Array of IObjectAttrValue types | |
IObjectAttrValue | id | integer |
|
textVal | string |
| |
boolVal | boolean |
| |
dateVal | date |
| |
intVal | integer |
| |
dblVal | number |
| |
additionalVal | string |
| |
invalidVal | string |
| |
refObjectId | integer |
|