Agiloft

App · 13 actions

Search Agiloft records, create and update contracts and other records, discover tables and fields, read attachment details and resolve choice IDs.

Actions

ActionWhat it does
Create recordCreate record.
Delete recordDelete record.
Get choice idGet choice id.
Get recordGet record.
Get record lockGet record lock.
Get tableGet table.
List record attachmentsList record attachments.
List saved searchesList saved searches.
List tablesList tables.
Search recordsSearch records.
Select record idsSelect record ids.
Update recordUpdate record.
Upsert recordUpsert record.

Create record

Create record.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
FieldsfieldsobjectRequired
Record fields by logical name. Choice fields take their displayed text.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Delete record

Delete record.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
Record idrecord_idtextRequired
The record id.
Delete ruledelete_ruletextRequired
Fail if dependent records exist, or unlink dependent records. Cascading deletion is not offered.One of: ERROR_IF_DEPENDANTS (Error if dependants), APPLY_UNLINK (Apply unlink).

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Get choice id

Get choice id.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
FieldfieldtextRequired
The field.
ValuevaluetextRequired
The value.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Get record

Get record.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
Record idrecord_idtextRequired
The record id.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Get record lock

Get record lock.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
Record idrecord_idtextRequired
The record id.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Get table

Get table.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
Include linked infoinclude_linked_infotrue/false
The include linked info.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "tables": []
    },
    "success": true
  }
}

List record attachments

List record attachments.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
Record idrecord_idtextRequired
The record id.
FieldfieldtextRequired
The field.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": [],
    "success": true
  }
}

List saved searches

List saved searches.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": [],
    "success": true
  }
}

List tables

List tables.

Inputs

Skip columns infoskip_columns_infotrue/false
The skip columns info.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "tables": []
    },
    "success": true
  }
}

Search records

Search records.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
QueryquerytextRequired
A search expression, such as summary~='test'.
Fieldfieldlist
Logical field names to return.
Pagepagenumber
The page.At least 0.
Limitlimitnumber
The limit.From 1 to 1000.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Select record ids

Select record ids.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
WherewheretextRequired
An Agiloft SQL condition, such as id=123.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Update record

Update record.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
Record idrecord_idtextRequired
The record id.
FieldsfieldsobjectRequired
Record fields by logical name. Choice fields take their displayed text.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

Upsert record

Upsert record.

Inputs

Table nametable_nametextRequired
Select the logical table name. Names are case sensitive.
Match querymatch_querytextRequired
A unique match, such as external_id='CRM-123'.
FieldsfieldsobjectRequired
Record fields by logical name. Choice fields take their displayed text.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "message": "",
    "result": {
      "id": 12
    },
    "success": true
  }
}

On this page