Agiloft

Nutzungsanweisungen

Integrate with Agiloft contract lifecycle management to create, read, update, delete, and search records. Supports file attachments, SQL-based selection, saved searches, and record locking across any table in your knowledge base.

Tools

`agiloft_attach_file`

Attach a file to a field in an Agiloft record.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts")
`recordId`	string	Ja	ID of the record to attach the file to
`fieldName`	string	Ja	Name of the attachment field
`file`	file	Nein	File to attach
`fileName`	string	Nein	Name to assign to the file (defaults to original file name)

Ausgabe

Parameter	Typ	Beschreibung
`recordId`	string	ID of the record the file was attached to
`fieldName`	string	Name of the field the file was attached to
`fileName`	string	Name of the attached file
`totalAttachments`	number	Total number of files attached in the field after the operation

`agiloft_attachment_info`

Get information about file attachments on a record field.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts")
`recordId`	string	Ja	ID of the record to check attachments on
`fieldName`	string	Ja	Name of the attachment field to inspect

Ausgabe

Parameter	Typ	Beschreibung
`attachments`	array	List of attachments with position, name, and size
↳ `position`	number	Position index of the attachment in the field
↳ `name`	string	File name of the attachment
↳ `size`	number	File size in bytes
`totalCount`	number	Total number of attachments in the field

`agiloft_create_record`

Create a new record in an Agiloft table.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts", "contacts.employees")
`data`	string	Ja	Record field values as a JSON object (e.g., {"first_name": "John", "status": "Active"})

Ausgabe

Parameter	Typ	Beschreibung
`id`	string	ID of the created record
`fields`	json	Field values of the created record

`agiloft_delete_record`

Delete a record from an Agiloft table.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts", "contacts.employees")
`recordId`	string	Ja	ID of the record to delete

Ausgabe

Parameter	Typ	Beschreibung
`id`	string	ID of the deleted record
`deleted`	boolean	Whether the record was successfully deleted

`agiloft_get_choice_line_id`

Resolve the internal numeric ID of a choice-list value, for use in EWSelect WHERE clauses against choice fields.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "case", "contracts")
`fieldName`	string	Ja	Choice field name (e.g., "priority", "status")
`value`	string	Ja	Choice display value to resolve (e.g., "High", "Active")

Ausgabe

Parameter	Typ	Beschreibung
`choiceLineId`	number	Internal numeric line ID of the choice value

`agiloft_lock_record`

Lock, unlock, or check the lock status of an Agiloft record.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts")
`recordId`	string	Ja	ID of the record to lock, unlock, or check
`lockAction`	string	Ja	Action to perform: "lock", "unlock", or "check"

Ausgabe

Parameter	Typ	Beschreibung
`id`	string	Record ID
`lockStatus`	string	Lock status (e.g., "LOCKED", "UNLOCKED")
`lockedBy`	string	Username of the user who locked the record
`lockExpiresInMinutes`	number	Minutes until the lock expires

`agiloft_read_record`

Read a record by ID from an Agiloft table.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts", "contacts.employees")
`recordId`	string	Ja	ID of the record to read
`fields`	string	Nein	Comma-separated list of field names to include in the response

Ausgabe

Parameter	Typ	Beschreibung
`id`	string	ID of the record
`fields`	json	Field values of the record

`agiloft_remove_attachment`

Remove an attached file from a field in an Agiloft record.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts")
`recordId`	string	Ja	ID of the record containing the attachment
`fieldName`	string	Ja	Name of the attachment field
`position`	string	Ja	Position index of the file to remove (starting from 0)

Ausgabe

Parameter	Typ	Beschreibung
`recordId`	string	ID of the record
`fieldName`	string	Name of the attachment field
`remainingAttachments`	number	Number of attachments remaining in the field after removal

`agiloft_retrieve_attachment`

Download an attached file from an Agiloft record field.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts")
`recordId`	string	Ja	ID of the record containing the attachment
`fieldName`	string	Ja	Name of the attachment field
`position`	string	Ja	Position index of the file in the field (starting from 0)

Ausgabe

Parameter	Typ	Beschreibung
`file`	file	Downloaded attachment file

`agiloft_saved_search`

List saved searches defined for an Agiloft table.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name to list saved searches for (e.g., "contracts")

Ausgabe

Parameter	Typ	Beschreibung
`searches`	array	List of saved searches for the table
↳ `name`	string	Saved search name
↳ `label`	string	Saved search display label
↳ `id`	string	Saved search database identifier
↳ `description`	string	Saved search description

`agiloft_search_records`

Search for records in an Agiloft table using a query.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name to search in (e.g., "contracts", "contacts.employees")
`query`	string	Ja	Search query using Agiloft query syntax (e.g., "status='Active'" or "company_name~='Acme'")
`fields`	string	Nein	Comma-separated list of field names to include in the results
`page`	string	Nein	Page number for paginated results (starting from 0)
`limit`	string	Nein	Maximum number of records to return per page

Ausgabe

Parameter	Typ	Beschreibung
`records`	json	Array of matching records with their field values
`totalCount`	number	Total number of matching records
`page`	number	Current page number
`limit`	number	Records per page

`agiloft_select_records`

Select record IDs matching a SQL WHERE clause from an Agiloft table.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts", "contacts.employees")
`where`	string	Ja	SQL WHERE clause using database column names (e.g., "summary like '%new%'" or "assigned_person='John Doe'")

Ausgabe

Parameter	Typ	Beschreibung
`recordIds`	array	Array of record IDs matching the query
`totalCount`	number	Total number of matching records

`agiloft_update_record`

Update an existing record in an Agiloft table.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`instanceUrl`	string	Ja	Agiloft instance URL (e.g., https://mycompany.agiloft.com\)
`knowledgeBase`	string	Ja	Knowledge base name
`login`	string	Ja	Agiloft username
`password`	string	Ja	Agiloft password
`table`	string	Ja	Table name (e.g., "contracts", "contacts.employees")
`recordId`	string	Ja	ID of the record to update
`data`	string	Ja	Updated field values as a JSON object (e.g., {"status": "Active", "priority": "High"})

Ausgabe

Parameter	Typ	Beschreibung
`id`	string	ID of the updated record
`fields`	json	Updated field values of the record

Agiloft

On this page