Overview
Archer is an integrated risk management platform. The Automize connector works against the Archer Platform REST/content API: it reads and writes content records in any application, and reads the metadata around them — applications, levels, field definitions, values lists, users and groups.
Setting up the connection
Auth type: login_exchange.
- Get the host, without a scheme — e.g. archer.acme.com or acme.archerirm.cloud.
- Get the instance name. It is the instance you pick on the Archer login page.
- Use a named Archer service account rather than a person's login, and give it read/write on only the applications the process touches.
- Set User domain only for a Windows domain account. Leave it blank for a local Archer account.
- Leave API root as platformapi unless this is an older on-premise instance that keeps the application under an /RSAarcher virtual directory.
- In Automize, open Settings → Connectors → Archer → Add connection and fill those in. Automize exchanges the username and password for a session token on each run; nothing but the token rides the API calls.
Available operations
21 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Create Content Record | General | Create a content record. The body is Archer's Content wrapper — {'Content': {'LevelId': …, 'FieldContents': {fieldId: {...}}}} — where each field's shape depends on its type. |
| Delete Content Record | General | Delete a content record by its ID |
| Get Application | General | Get one application by its ID |
| Get Attachment | General | Download an attachment by its ID |
| Get Content Record | General | Get one content record by its ID |
| Get Content by Reference Field | General | Get the content records referenced by a cross-reference field |
| Get Content History | General | Get a content record's history-log entries |
| Get Field Content | General | Get specific fields of specific content records |
| Get Group | General | Get one group by its ID |
| Get User | General | Get one user by their ID |
| List Applications | General | List all applications in the instance |
| List Field Definitions (by Application) | General | List an application's field definitions — the source of the field IDs a write needs |
| List Field Definitions (by Level) | General | List a level's field definitions |
| List Groups | General | List all groups |
| List Levels | General | List all levels (an application's record layouts) |
| List Levels by Module | General | List the levels contained by one module |
| List Users | General | List users. Narrow with OData $filter/$select/$orderby |
| List Values-List Values | General | List the flattened values of a values list (for populating a values-list field) |
| Login | General | Re-authenticate and refresh the Archer session token |
| Post Attachment | General | Upload an attachment (base64 bytes) and get back the attachment ID to reference on a record |
| Update Content Record | General | Update a content record. The body carries Id, LevelId, FieldContents and the record's current Version — a stale Version is rejected. |
Operations
Create Content Record
Create a content record. The body is Archer's Content wrapper — {'Content': {'LevelId': …, 'FieldContents': {fieldId: {...}}}} — where each field's shape depends on its type.
No input parameters.
Delete Content Record
Delete a content record by its ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Content ID contentId | Yes | string |
Get Application
Get one application by its ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Application ID applicationId | Yes | string |
Get Attachment
Download an attachment by its ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Attachment ID attachmentId | Yes | string |
Get Content Record
Get one content record by its ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Content ID id | Yes | string | |
Select fields $select | No | string | Comma-separated field names to return instead of the whole record. |
Get Content by Reference Field
Get the content records referenced by a cross-reference field
| Parameter | Required | Type | Description |
|---|---|---|---|
Reference field ID referenceFieldId | Yes | string | |
Reference field ID (query) id | Yes | string | |
OData $filter $filter | No | string | |
OData $select $select | No | string | |
OData $top $top | No | integer | |
OData $skip $skip | No | integer | |
OData $orderby $orderby | No | string |
Get Content History
Get a content record's history-log entries
| Parameter | Required | Type | Description |
|---|---|---|---|
Content ID contentId | Yes | string |
Get Field Content
Get specific fields of specific content records
No input parameters.
Get Group
Get one group by its ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Group ID groupId | Yes | string |
Get User
Get one user by their ID
| Parameter | Required | Type | Description |
|---|---|---|---|
User ID userId | Yes | string |
List Applications
List all applications in the instance
No input parameters.
List Field Definitions (by Application)
List an application's field definitions — the source of the field IDs a write needs
| Parameter | Required | Type | Description |
|---|---|---|---|
Application ID applicationId | Yes | string |
List Field Definitions (by Level)
List a level's field definitions
| Parameter | Required | Type | Description |
|---|---|---|---|
Level ID levelId | Yes | string |
List Groups
List all groups
No input parameters.
List Levels
List all levels (an application's record layouts)
No input parameters.
List Levels by Module
List the levels contained by one module
| Parameter | Required | Type | Description |
|---|---|---|---|
Module ID moduleId | Yes | string |
List Users
List users. Narrow with OData $filter/$select/$orderby
| Parameter | Required | Type | Description |
|---|---|---|---|
OData $filter $filter | No | string | |
OData $select $select | No | string | |
OData $orderby $orderby | No | string |
List Values-List Values
List the flattened values of a values list (for populating a values-list field)
| Parameter | Required | Type | Description |
|---|---|---|---|
Values list ID valuesListId | Yes | string |
Login
Re-authenticate and refresh the Archer session token
No input parameters.
Post Attachment
Upload an attachment (base64 bytes) and get back the attachment ID to reference on a record
No input parameters.
Update Content Record
Update a content record. The body carries Id, LevelId, FieldContents and the record's current Version — a stale Version is rejected.
No input parameters.
FAQ
- Why does an update need a level ID as well as a record ID?
- Archer content is typed by level, not by application — an application can have several levels and the field IDs differ between them. List Levels by Module and List Field Definitions (by Level) give you the pair to work from.
- How do I find a record without knowing its content ID?
- Use Get Content by Reference Field, which looks a record up by the value of a field you already hold (an employee number, a case reference), then feed the returned content ID into Update or Delete.