Version: v5.0

Types

Agent#

Represents a Agent

Property	Type	Description
_id	String	The id of the agent resource
_namespaces	Array<String>	Required, The namespace(s) of the resource.
_name	String	Required, The agent name
_description	String	Agent's description
_background	String	Required, The context for the agent
_userType	String	Required, unique identifier of the agent
_type	String	The type of the agent, The backend will assign the value for this
_agentClass	String	The class name of the custom agent if it is implemented.
_config	AgentConfig	Required, defines the llm model.

AgentCriteria#

Agent criteria

Type: Object

Property	Type	Description
_userType	String	Filter by _userType field
_type	String	The valid values are user_agent or system_agent
query	String	Wild card search that operates on the name, description and background, for example, ?query=anamoly

AisvcOptions#

Use to set response options for AiSvc requests.

Type: Object

Property	Type	Description
_offset	Number	Sets the number of results to skip in the Page response. For example, set to to skip the first 10 results.
_pageSize	Number	Sets the number of results to return per Page in the response

Application#

The Application type defines an application.

Type: Object

Property	Type	Description
_id	String	Application UUID
_name	String	required, Application name
_description	String	Application description
_appOwner	String	required, Application owner
_namespaces	Array<String>	Namespaces that the application pertains to
_redirecUris	String	required, Comma separated string with redirect URIs to receive the access_token after a successful authentication.
_authorizedOrigins	String	Comma separated string with the authorized origin restriction. Authentication from any other origins will be restricted.
_home	String	Application home page URL
_orgId	String	required, Organization Id
_whitelistedApps	Array<String>	An array of app ids for the Applications that can access resources in this app.
_loginTheme	String	optional, Login Theme supported by the platform

Chat#

Represents a chat entry in a conversation.

Type: Object

Property	Type	Description
_id	String	The chat entry id.
_conversationId	String	The conversation id this chat belongs to.
_prompt	any	The prompt input for this chat entry.
_llmResponse	any	The LLM response for this prompt.
_duration	number	Duration of LLM processing.
_embedding	Array<number>	Embedding vector for chat.
_status	number	Status code of chat entry.
_summary	any	Summary of the chat response.
_metadata	AuditableDTO	Metadata containing creation and update info.
_teamId	String	The team id associated with the conversation.

Conversation#

Represents a conversation resource.

Type: Object

Property	Type	Description
_id	String	The conversation id.
_namespaces	Array<String>	Namespaces associated with the conversation.
_title	String	The title of the conversation.
_userId	String	The user id who created the conversation.
_status	number	Status of the conversation.
_embeddingModel	String	The embedding model used.
_metadata	Object	Metadata including timestamps and user info.
_chats	Array<Chat>	Array of chat entries.

ConversationCreateRequest#

Request to create a new conversation or continue an existing one.

Type: Object

Property	Type	Description
_input	ConversationInput	Input message for the conversation.
_teamId	String	The team id for the conversation.
_id	String	(Optional) Conversation id to continue an existing conversation.

ConversationInput#

Represents the input for a conversation message.

Type: Object

Property	Type	Description
message	String	The message content.

ConversationOptions#

Options for retrieving a conversation.

Type: Object

Property	Type	Description
getChats	boolean	Whether to include chat messages in the response.
firstN	number	Number of first chats to retrieve.
lastN	number	Number of last chats to retrieve.
offset	number	Offset of chats to retrieve.
textToMatch	string	Text to match in chats.

CreatePermissionsResponse#

The response object when you create a Permission

Type: Object

Property	Type	Description
_success	Array<Permission>	An array of the successfully created permissions
_failures	Array<Permission>	An array of the failed permissions and the reason for failure

Ctx#

Use a Ctx object to maintain project or session context.

Type: Object

Property	Type	Description
noAuth	boolean	Enter if no authentication is required
authToken	String	Use to store an authentication token, if required
_namespaces	Array<String>	Stores namespaces when nsfilter is used
storage	JSON	Session storage

File#

Data type for a source file in the File Service.

Type: Object

Property	Type	Description
_id	String	The File's database id
_name	String	The file name
_tipId	String	Latest version id
_tipVersion	Number	Latest version number
_nextVersion	Number	Next version number
_type	String	Either "file" or "dir"
_irn	String	Platform resource name with pattern as filesvc:file:<_id>
_namespaces	Array	List of namespaces that the UserGroup has access to
_tags	Array	Add custom tags to the File
_fileVersion	FileVersion	Version details
_uploadMeta	UploadMeta	Upload metadata if the file is uploaded as a resumable file upload
_url	String	File download URL that lasts 48 hours. Only appears as part of a request specific to get the download URL, such as GET /files/:id/url api response or IafFileSvc.getFileUrl().

FileContainer#

Type: NamedFileCollection

Property	Type	Description
_version	FileContainerVersion	version

FileContainerVersion#

Type: NamedFileCollectionVersion

Property	Type	Description
_userAttributes	JSON	it contains 'path' refers to file container(folder) path, '/' for root container

FileCriteria#

Criteria to target a source file in the File Service.

Type: Object

Property	Type	Description
_namespaces	(Array<String> \| String)	Namespaces to filter. Please note that these namespaces must be present in nsfilter. If its not provided get files from all the namespaces in the nsfilter
_parents	String	Folder id to filter. Without an id, the request considers files from all folders. Use 'root' to filter by a root folder.
_ids	String	A comma separted string of file ids to search.
_tags	(Array<String> \| String)	A tag or array of tags to filter by. It supports both regex and exact match
_name	String	Filter by file name. Supports regex.

Examples

// Get all the files from all the folders from namespaces in the ctx let criteria = {} let files = IafFileSvc.getFiles(criteria, ctx);
// Get all files from root folder let criteria = {"_parents": "root"} let res = await IafFileSvc.getFiles(criteria, ctx);
// Get all files from specific folder let criteria = {"_parents": "5a25417d-1408-42d4-b9a2-812be53bb111"} let res = await IafFileSvc.getFiles(criteria, ctx);
// Get all files by ids let criteria = {"_ids": "5a25417d-1408-42d4-b9a2-812be53bb111,f3dc8288-39f1-4d7c-9b4b-51fe364db874,bf03bc5f-bfe4-40f4-91fd-5ece6effbe99"} let res = await IafFileSvc.getFiles(criteria, ctx);
//Get All bimpk files let criteria = {"_name":".*bimpk"} let res = await IafFileSvc.getFiles(criteria, ctx);

FileHeaders#

These headers will be applied to the HTTP response during download if they were specified during upload.

Type: Object

Property	Type	Description
null	String	"content-type" - Mime type of the file, Ex: image/png, application/pdf or image/svg+xml
null	String	"content-encoding" - Content encoding type. Ex: gzip

FileItem#

An object that represents a source file with user-created properties that can be related to NamedUserCollection types and other RelatedItem types.

Type: RelatedItem

Property	Type	Description
_fileId	String	Refers to the source file's id in File Service
_fileVersionId	String	Refers to the source file version's id in File Service

FilePreviewOptions#

Options for displaying a preview. Currently it is only available for images and it is generated 640x480 dimension only.

Type: Object

Property	Type	Description
width	Number	Preview image width.
height	Number	Preview image height

FileVersion#

A version of a source file

Type: Object

Property	Type	Description
_id	String	The FileVersion's id
_version	Number	The version number
_fileSize	Number	The file's memory size
_fileId	String	Id reference of the source file
_url	String	File download URL that lasts 48 hours. Only appears as part of a request specific to get the download ULR, such as GET /files/:id/versions/:versionId/url api response or IafFileSvc.getFileVersionUrl().

GeometryView#

Use the GeometryView type to define a geometry view.

Type: Object

Property	Type	Description
index	Number	Enter the index of your view to identify it in an array of views from a model
label	String	View title
value	String	File id that represents the view

IafActionDescriptor#

Type: Object

Property	Type	Description
actions	Array<String>
desc	JSON	criteria with key value pair

IafPermissionDescriptor#

It defines permissions for various resources. It usually helps to define permissions for a user group in a project while creating the user group.

Type: Object

Property	Type	Description
accessAll	boolean	Provide all actions to all the resources for a given namespace. If it's true then all other resources defined below will be ignored.
workspaces	Array<IafActionDescriptor>
namedUserItems	Array<IafActionDescriptor>
namedUserColls	Array<IafActionDescriptor>
files	Array<IafActionDescriptor>
scripts	Array<IafActionDescriptor>
userConfigs	Array<IafActionDescriptor>
permissionProfiles	Array<IafActionDescriptor>
apiconfigdefs	Array<IafActionDescriptor>
orchestrator	Array<IafActionDescriptor>
telemetryconfigs	Array<IafActionDescriptor>
usergroups	Array<IafActionDescriptor>	Define allowed permission actions for a user group on the same user group. For example, if the permissions are given as ["READ", "EDIT"], the members of the user group can read and edit the user group.

Index#

Type: Object

Property	Type	Description
key	JSON	Properties to index
options	JSON	Pass your index options

Invite#

Use the Invite type to define a user invite to a project or user group.

Type: Object

Property	Type	Description
_id	String	Invite UUID
_email	String	Email address to send the invite to
_expireTime	Number	The system generates a expiry time for the invite, which is seven days from the invite creation.
_userExists	boolean	The system determines if the user's email address is registered or not.

InviteCriteria#

Find Invites by criteria

Type: Object

Property	Type	Description
_status	Array<String>	Filter invites by the statuses you pass in the array

InviteOptions#

Use the InviteOptions type to add response options for Invite queries.

Type: Object

Property	Type	Description
_offset	Number	Sets the number of results to skip in the Page response. For example, set to to skip the first 10 results.
_pageSize	Number	Sets the number of results to return per Page in the response
includeAll	boolean	Set to true to include all the invites instead of particular page

InviteParams#

Type: Object

Property	Type	Description
invite_link	String	invite link which user will be clicked in the email, invite id would be appended by the system
type	String	type of invite(Ex: Project)
name	String	name of the invite (Ex: Project name)
inviter_name	String	inviter's name

ItemsvcOptions#

Use to set response options for Item Service requests.

Type: Object

Property	Type	Description
transactional	boolean	Set to true to make POST, PUT or DELETE requests transactional.

KnowledgeBase#

Represents a KnowledgeBase resource.

Type: Object

Property	Type	Description
_id	String	The id of the knowledge base resource.
_name	String	Name of the knowledge base.
_fileId	String	Source file id stored in file service.
_fileVersionId	String	Version id of the file.
_vectorizedStatus	String	Vectorization status, e.g., VECTORIZED or PENDING.
_userType	String	User type identifier for knowledge base.
_namespaces	Array<String>	Namespaces associated with the knowledge base.
_irn	String	Internal resource name.
_metadata	Object	Metadata containing createdAt, updatedAt, createdById, updatedById.

KnowledgeBaseCriteria#

Criteria for filtering KnowledgeBase resources.

Type: Object

Property	Type	Description
_id	String	Filter by id.
_name	String	Filter by name.
_userType	String	Filter by user type.
_vectorizedStatus	String	Filter by vectorization status.
query	String	Wildcard search against name

NamedFileCollection#

A user-created FileItem collection. The NamedFileCollection class is a subclass of the NamedUserCollection class and inherits its properties and the properties the NamedUserCollection class itself inherits.

Type: NamedUserCollection

Property	Type	Description
_version	NamedFileCollectionVersion	A given version of the NamedFileCollection.

NamedFileCollectionVersion#

Type: NamedUserCollectionVersion

NamedUserCollection#

A user-created RelatedItem collection. The NamedUserCollection class is a subclass of the NamedUserItem class and inherits its properties.

Type: NamedUserItem

Property	Type	Description
_version	NamedUserCollectionVersion	A given version of the NamedUserCollection.
_encryptionEnabled	Boolean	Enables encryption for the NamedUserCollection. If set to True then any related items prefixed with a . will be encrypted.

NamedUserCollectionVersion#

Type: NamedUserItemVersion

NamedUserItem#

The foundational item type in the platform. All NamedUserItem subclasses, such as NamedUserCollection subclasses as well as UserConfig and Script subclasses inherit the properties of this class.

Type: Object

Property	Type	Description
_id	String	The NamedUserItem's database id
_name	String	A readable, long-form name
_description	String	A string that describes the purpose of the NamedUserItem class instance
_shortName	String	Shorter abbreviation of the NamedUserItem name that is used for reference
_userType	String	A user-given name to identify a NamedUserItem. This userType is helpful for queries to find a unique item with a unique userType or NamedUserItems that share a userType.
_userItemId	String	A unique id value generated by the Item Service.
_version	NamedUserItemVersion	Contain's version data

NamedUserItemCriteria#

Query criteria you can pass in Item Service platform APIs to target specific NamedUserItem classes based on your query.

Type: Object

Property	Type	Description
query	JSON	Pass a simple query object. For more information, see the following examples.

Examples

// simple filter exampleslet query = {"_usertype": "project_setup","_name": "projectSetup"}let query = {"_id": {"$in": ["5c9328e8b834740001cd95d4","5c9328e8b834740001cd95d4"]}}
// Complex querylet query = { "$and": [   {      "_userType": "file_container",     "_name": "Root Container"   } ], "$or": [   {     "_tipVersion": 1   },   {     "_id": {       "$in": ["5c9328e8b834740001cd95d4","5d31574411efe92d8832c21c"]     }   } ]}
// Query with versionlet query = {  "$and": [    {      "_userType": "platform_setup_script",      "_name": "setup_script"    }  ],  "$or": [    {      "_versions._userAttributes.key": "value"    },    {      "_id": {         "$in": ["5c9328e8b834740001cd95d4", "5d31574411efe92d8832c21c"]      }    }  ]}
// Query with all versionslet query = {  "$and": [    {       "_name": "setup_script",       "_userType":"platform_setup_script"    }  ],  "$or": [    {       "_versions._userAttributes.key": "version2Value"    },    {      "_versions._userAttributes.config": {        "$in":["value1","value2"]      }    }  ],   "_versions.all": true}

NamedUserItemCriteriaOptions#

Define response options for NamedUserItems with Item Service platform APIs.

Type: Object

Property	Type	Description
project	JSON	Pass an object that contains one or more projection criteria specifiers.
sort	JSON	Pass an object that contains one or more sort criteria specifiers. Set a property to 1 to sort ascending and -1 to sort descending.
page	PageRequest	Pass an object that contains one or more pagination options.
pagedRes	boolean	Set to true to get a Page class result rather than an array, which is the default. The default page size is 200, which is also the maximum.

Examples

// Simple optionslet options = {  "project":{ "_userType": 1, "_itemClass": 1},  "sort": { "_name": 1 },   "page": { "_offset": 10, "_pageSize": 20 }}
// with versionslet options = { "project": { "_userType": 1, _versions._userAttributes.classification_system_name: 1 }, "sort": { "_name": 1},  "page": { "_offset": 10, "_pageSize": 20} }

NamedUserItemVersion#

Represents a version of a given NamedUserItem, contained in the NamedUserItem's _version array.

Type: Object

Property	Type	Description
_id	String	The NamedUserItemVersion's database id
_userAttributes	JSON	Add custom key-value pairs. Add the attribute name to the key, for example, _userAttributes.<attribute_name>: <attribute_value>
_version	Number	The version number, which is generated and not editable
_userItemId	String	Refers to the _userItemId value in the parent NamedUserItem
_itemClass	String	Refers to the _itemClass value in the parent NamedUserItem
_userItemDbId	String	Refers to the _id value in the parent NamedUserItem

NamedUserItemVersionCloneOptions#

When you clone NamedUserCollections, pass a NamedUserItemVersionCloneOptions object to define if you also want to clone the NamedUserCollections's relationships and inverse relationships.

Type: Object

Property	Type	Description
relationships	boolean	For NamedUserCollections, set to true to also clone the NamedUserCollection's relationships
inverseRelationships	boolean	For NamedUserCollections, set to true to also clone the NamedUserCollection's inverse relationships

NamedUserItemVersionCriteria#

Query criteria you can pass in Item Service platform APIs to target specific NamedUserItemVersion classes based on your query.

Type: Object

Property	Type	Description
query	JSON	Pass a simple query

Examples

// simple filter exampleslet query = { "_userAttributes.fileId": "4e2b9de5-9a73-44f9-8153-bc0904b694c5" }let query = { "_id": {"$in": ["5c9328e8b834740001cd95d4","5c9328e8b834740001cd95d4"]}}
// complex querylet query = {   "$and": [    {       "_userAttributes.fileId" :"4e2b9de5-9a73-44f9-8153-bc0904b694c5",      "_userAttributes.name": "Sample"    }  ],  "$or": [    {       "_id": {         "$in": [ "5c9328e8b834740001cd95d4","5d31574411efe92d8832c21c" ]      }    }  ]}

NotificationDevice#

Represents a notification device

Type: Object

Property	Type	Description
_id	String	The id of the resource
_owner	NotificationOwner	The owner of the device
_createdAt	Date	The timestamp for resource creation
_updatedAt	Date	The timestamp for resource modification
_version	Number	The current version of the resource (used for optimistic concurrency)
_transport	NotificationTransport	The notification transport type for this device
_email	NotificationDeviceEmail	Configuration for an email device
_status	NotificationDeviceStatus	Current status of the device

NotificationDeviceEmail#

Represents a notification email device configuration

Type: Object

Property	Type	Description
_address	String	Email address

NotificationDeviceQuery#

Represents a notification group query

Type: Object

Property	Type	Description
ids	Array<String>	The ids to match
owner	NotificationOwnerQuery	The owner to match

NotificationDeviceStatus#

Represents a notification sender redirect

Type: (UNKNOWN: StringLiteralType | UNKNOWN: StringLiteralType)

NotificationGroup#

Represents a notification group

Type: Object

Property	Type	Description
_id	String	The id of the resource
_namespaces	Array<String>	The namespace(s) of the resource.
_createdAt	Date	The timestamp for resource creation
_updatedAt	Date	The timestamp for resource modification
_version	Number	The current version of the resource (used for optimistic concurrency)
_name	String	The resource name
_description	String	The resource description

NotificationGroupQuery#

Represents a notification group query

Type: Object

Property	Type	Description
ids	Array<String>	The ids to match
namespaces	Array<String>	The namespace(s) to match
name	String	The names to match

NotificationNotification#

Represents a notification (i.e. sent history)

Type: Object

Property	Type	Description
_id	String	The id of the resource
_namespaces	Array<String>	The namespace(s) of the resource.
_owner	NotificationOwner	The owner of the resource
_createdAt	Date	The timestamp for resource creation
_updatedAt	Date	The timestamp for resource modification
_version	Number	The current version of the resource (used for optimistic concurrency)
_template	NotificationTemplate	The template used to generate this notification
_trigger	NotificationTrigger	The trigger that caused this notification
_sender	NotificationSender	The sender that sent this notification
_subscription	NotificationSubscription	The subscription that caused this notification
_transport	NotificationTransport	The transport type
_email	NotificationTemplateEmail	The email notification body (if transport type is email)

NotificationNotificationQuery#

Represents a notification query

Type: Object

Property	Type	Description
ids	Array<String>	The ids to match
namespaces	Array<String>	The namespace(s) to match
owner	NotificationOwnerQuery	The owner to match
name	String	The names to match

NotificationOwner#

Represents a notification device owner

Type: Object

Property	Type	Description
_irn	String	Owner IRN

NotificationOwnerQuery#

Represents a notification device owner

Type: Object

Property	Type	Description
irn	String	Owner IRN

NotificationScript#

Represents a notification script

Type: Object

Property	Type	Description
_id	String	The id of the script to execute.

NotificationSender#

Represents a sender

Type: Object

Property	Type	Description
_id	String	The id of the resource
_namespaces	Array<String>	The namespace(s) of the resource.
_createdAt	Date	The timestamp for resource creation
_updatedAt	Date	The timestamp for resource modification
_version	Number	The current version of the resource (used for optimistic concurrency)
_name	String	The resource name
_description	String	The resource description
_transport	NotificationTransport	The notification transport type for this sender
_email	NotificationSenderEmail	Email sender configuration
_templates	Map<NotificationSenderAction NotificationTemplate>	Templates to use for each pre-defined sender action
_redirects	Map<NotificationSenderRedirect String>	Redirect URLs for each pre-defined sender redirect step

NotificationSenderAction#

Represents a notification sender action

Type: UNKNOWN: StringLiteralType

NotificationSenderEmail#

Represents a notification email sender configuration

Type: Object

Property	Type	Description
_address	String	The sender address
_displayName	String	The sender displayName

NotificationSenderQuery#

Represents a notification group query

Type: Object

Property	Type	Description
ids	Array<String>	The ids to match
namespaces	Array<String>	The namespace(s) to match
name	String	The names to match

NotificationSenderRedirect#

Represents a notification sender redirect

NotificationSubscription#

Represents a notification subscription

Type: Object

Property	Type	Description
_id	String	The id of the resource
_namespaces	Array<String>	The namespace(s) of the resource.
_group	NotificationGroup	The group to subscribe to
_device	NotificationDevice	The device to subscribe with
_status	NotificationSubscriptionStatus	Current status of the subscription
_version	Number	The current version of the resource (used for optimistic concurrency)
_requestedAt	Date	The last time an attempt was made to confirm the subscriber
_acceptedAt	Date	The last time the subscription was accepted
_cancelledAt	Date	The last time the subscription was cancelled

NotificationSubscriptionQuery#

Represents a notification group query

Type: Object

Property	Type	Description
ids	Array<String>	The ids to match
namespaces	Array<String>	The namespace(s) to match
name	String	The names to match

NotificationSubscriptionStatus#

Represents a notification sender redirect

Type: (UNKNOWN: StringLiteralType | UNKNOWN: StringLiteralType | UNKNOWN: StringLiteralType | UNKNOWN: StringLiteralType)