ArcherIRM
ArcherIRM is a platform that helps organizations manage risk, compliance, and governance processes.
ArcherIRM is a comprehensive governance, risk, and compliance (GRC) platform that enables organizations to manage risk-related data efficiently. The ArcherIRM connector for Swimlane Turbine allows users to automate the creation, retrieval, updating, and deletion of records within ArcherIRM, as well as manage applications, users, and groups. By integrating ArcherIRM with Swimlane Turbine, users can streamline GRC processes, enhance security operations, and improve response times through automated workflows and data management.
Prerequisites
Before you can use the ArcherIRM connector for Turbine, you'll need access to the ArcherIRM API. This requires the following:
- RSA archer authentication using the following parameters:
- URL: The endpoint for accessing ArcherIRM services.
- Instance Name: The specific instance of ArcherIRM you are connecting to.
- Username: Your ArcherIRM account username.
- Password: Your ArcherIRM account password.
- API Path: The path to the API resources within ArcherIRM.
Turn on API Read Permissions
The set of credentials for this plugin require read permissions for the API.
To turn on API read permissions:
- Navigate to the login page and login.
- From the Administration pull-down menu, select Access Roles.
- On Manage Access Role: API access, select the Rights tab and then select Read permissions for Manage Security Parameters.
- Ensure Manage Security Parameters read permissions is selected.
Capabilities
This connector provides the following capabilities:
- Create Record
- Delete Record
- Get all Applications
- Get all Groups
- Get all Users
- Get application by ID
- Get Field Definition by Application ID
- Get Group by ID
- Get Record
- Get User by ID
- Get Values List Field Definition by Level ID
- Retrieve Findings
- Update Record
- Search Records by Report ID or GUID
Notes
Configurations
RSA Archer Authentication
RSA archer authentication.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | The scheme, url, and optional port and root path pointing to Archer. | string | Required |
InstanceName | Target Archer instance name. | string | Required |
UserDomain | Optional user domain for provided user. | string | Optional |
Username | Username of the Archer API user. | string | Required |
Password | Password of the Archer API user. | string | Required |
api_path | The path to the url to use either /platformapi or /api for the API. | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Create Record
Initiate a new record creation in ArcherIRM using provided content data.
Endpoint
- URL: /core/content
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
Content | object | Optional | Response content |
Content.LevelId | number | Required | Unique identifier |
Content.FieldContents | object | Required | Response content |
Content.FieldContents.13867 | object | Optional | Response content |
Content.FieldContents.13867.Type | number | Optional | Type of the resource |
Content.FieldContents.13867.Tag | string | Optional | Response content |
Content.FieldContents.13867.Value | string | Optional | Value for the parameter |
Content.FieldContents.13867.FieldId | number | Optional | Unique identifier |
Content.FieldContents.13868 | object | Optional | Response content |
Content.FieldContents.13868.Type | number | Optional | Type of the resource |
Content.FieldContents.13868.Tag | string | Optional | Response content |
Content.FieldContents.13868.Value | string | Optional | Value for the parameter |
Content.FieldContents.13868.FieldId | number | Optional | Unique identifier |
Content.FieldContents.13870 | object | Optional | Response content |
Content.FieldContents.13870.Type | number | Optional | Type of the resource |
Content.FieldContents.13870.Tag | string | Optional | Response content |
Content.FieldContents.13870.Value | object | Optional | Value for the parameter |
Content.FieldContents.13870.Value.ValuesListIds | array | Optional | Unique identifier |
Content.FieldContents.13870.Value.OtherText | string | Optional | Value for the parameter |
Content.FieldContents.13870.FieldId | number | Optional | Unique identifier |
Content.FieldContents.13872 | object | Optional | Response content |
Content.FieldContents.13872.Type | number | Optional | Type of the resource |
Content.FieldContents.13872.Tag | string | Optional | Response content |
Content.FieldContents.13872.Value | array | Optional | Value for the parameter |
Content.FieldContents.13872.FieldId | number | Optional | Unique identifier |
Input Example
{"json_body":{"Content":{"LevelId":9,"FieldContents":{"13867":{"Type":1,"Tag":"Name (Text)","Value":"Record created via REST API","FieldId":13867},"13868":{"Type":1,"Tag":"Description (Text)","Value":"<p>This is a Text Area field containing HTML content with different <strong><span style=\"color: #ff0000;\">colors</span> </strong> and <span style=\"font-family: comic sans ms,sans-serif;\"><em><span style=\"font-size: 14pt;\">font </span></em></span><span style=\"font-size: 18pt;\">sizes</span>. <span style=\"background-color: #ffff00;\">This is highlighted yellow.</span></p>\r\n<p>My bullet points</p>\r\n<ul>\r\n<li>Point 1</li>\r\n<li>Point 2</li>\r\n</ul>\r\n<p>Image via link</p><img src=\"https://community.rsa.com/resources/images/palette-1013/RSA-Logo-55px.png\" />","FieldId":13868},"13870":{"Type":4,"Tag":"Severity (Values List)","Value":{"ValuesListIds":[63738,63821],"OtherText":"whatever"},"FieldId":13870},"13872":{"Type":12,"Tag":"Screenshot (Image)","Value":[2069],"FieldId":13872},"13877":{"Type":8,"Tag":"My Manager (Record Permissions)","Value":{"UserList":[{"Id":190},{"Id":2}],"GroupList":[{"Id":19}]},"FieldId":13877},"13881":{"Type":11,"Tag":"Attachments (Attachment)","Value":[2068],"FieldId":13881},"13886":{"Type":24,"Tag":"My Sub Forms (Sub-Form)","Value":[339019],"FieldId":13886},"13888":{"Type":3,"Tag":"My Date (Date)","Value":"2016-12-14","FieldId":13888},"13890":{"Type":2,"Tag":"My Number (Numeric)","Value":123.456,"FieldId":13890},"13907":{"Type":9,"Tag":"My Contacts (Cross-Reference to Contacts)","Value":[{"ContentId":205522},{"ContentId":318794},{"ContentId":325672}],"FieldId":13907},"13999":{"Type":3,"Tag":"My Date Time (Date)","Value":"2014-03-06T21:30:00","FieldId":13999},"14009":{"Type":7,"Tag":"My URLs (External Links)","Value":[{"Name":"RSA","Url":"https://www.rsa.com"},{"Name":"Archer Community","Url":"https://community.rsa.com/community/products/archer-grc"},{"Name":"Search Archer KBs","Url":"https://community.rsa.com/community/products/archer-grc/knowledge-base"},{"Name":"Archer Community discussion about PowerShell and API","Url":"https://community.rsa.com/message/866965"},{"Name":"KB 32481 - How to use the RSA Archer REST API with Windows PowerShell","Url":"https://community.rsa.com/docs/DOC-45643"}],"FieldId":14009},"14088":{"Type":16,"Tag":"My Matrix (Matrix)","Value":[{"RowId":63880,"ColumnId":63879}],"FieldId":14088},"14410":{"Type":19,"IpAddressBytes":"127.0.0.1","FieldId":14410},"14538":{"Type":8,"Tag":"My Users and Groups List (User/Groups List) and Max=1 and select from a limited list","Value":{"UserList":null,"GroupList":[{"Id":44}]},"FieldId":14538},"14573":{"Type":23,"Tag":"Test (Related Records to App)","Value":[339014,338736],"FieldId":14573}}},"SubformFieldId":123}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Links | array | Output field: Links |
Links.file_name | string | Name of the resource |
Links.file | string | Output field: Links.file |
RequestedObject | object | Output field: RequestedObject |
RequestedObject.Id | number | Unique identifier |
IsSuccessful | boolean | Whether the operation was successful |
ValidationMessages | array | Unique identifier |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"Links":[],"RequestedObject":{"Id":123454},"IsSuccessful":true,"ValidationMessages":["correct"]}}
Delete Record
Remove a specified content record from an application within ArcherIRM using the provided contentId.
Endpoint
- URL: /core/content/{{contentId}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.contentId | number | Required | The ID of the content record to delete. |
Input Example
{"path_parameters":{"contentId":253379}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}
Get all Applications
Retrieve metadata for all applications within ArcherIRM, including authentication headers.
Endpoint
- URL: /core/system/application
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
headers | object | Required | HTTP headers for the request |
headers.X-Http-Method-Override | string | Required | POST is valid only if you include the X-Http-Method-Override:GET statement in the request header. |
Input Example
{"headers":{"X-Http-Method-Override":"GET"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Archer | object | Output field: Archer |
Archer.Application | object | Output field: Archer.Application |
Archer.Application.Guid | string | Unique identifier |
Archer.Application.Id | number | Unique identifier |
Archer.Application.LanguageId | number | Unique identifier |
Archer.Application.Name | string | Name of the resource |
Archer.Application.Status | number | Status value |
Archer.Application.Type | number | Type of the resource |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"Archer":{"Application":{}}}}
Get all Groups
Retrieve all user groups from ArcherIRM, requiring headers for authentication and authorization.
Endpoint
- URL: /core/system/group
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
headers | object | Required | HTTP headers for the request |
headers.X-Http-Method-Override | string | Required | POST is valid only if you include the X-Http-Method-Override:GET statement in the request header. |
Input Example
{"headers":{"X-Http-Method-Override":"GET"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"Links":[],"RequestedObject":{},"IsSuccessful":true,"ValidationMessages":[]}]}
Get all Users
Retrieve all users from the current ArcherIRM instance, requiring specific headers for authentication.
Endpoint
- URL: /core/system/user
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
headers | object | Required | HTTP headers for the request |
headers.X-Http-Method-Override | string | Required | POST is valid only if you include the X-Http-Method-Override:GET statement in the request header. |
Input Example
{"headers":{"X-Http-Method-Override":"GET"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"Links":[],"RequestedObject":{},"IsSuccessful":true,"ValidationMessages":[]}]}
Get application by ID
Retrieve metadata for an application in ArcherIRM using the specified application ID as a path parameter.
Endpoint
- URL: core/system/application/{{applicationid}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.applicationid | number | Required | Parameters for the Get application by ID action |
Input Example
{"path_parameters":{"applicationid":1}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Field Definition by Application ID
Retrieve field definitions for a specified application ID in ArcherIRM using the 'applicationid' path parameter.
Endpoint
- URL: /core/system/fielddefinition/application/{{applicationid}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.applicationid | string | Required | The application ID to get the application fields. |
Input Example
{"path_parameters":{"applicationid":"75"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Archer | object | Output field: Archer |
Archer.ApplicationField | array | Output field: Archer.ApplicationField |
Archer.ApplicationField.FieldId | number | Unique identifier |
Archer.ApplicationField.FieldName | string | Name of the resource |
Archer.ApplicationField.FieldType | string | Type of the resource |
Archer.ApplicationField.LevelID | number | Unique identifier |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"Archer":{"ApplicationField":[]}}}
Get Field Definition by Level ID
Retrieve field definition by specified level ID in ArcherIRM. Requires path parameter 'levelid' to return base class properties usable in OData query strings.
Endpoint
- URL: core/system/fielddefinition/level/{{levelid}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.levelid | number | Required | Parameters for the Get Field Definition by Level ID action |
Input Example
{"path_parameters":{"levelid":9}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Group by ID
Retrieve a specific group from ArcherIRM using the provided group ID as a path parameter.
Endpoint
- URL: /core/system/group/{{groupId}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.groupId | number | Required | ID of group content to be retrieved. |
Input Example
{"path_parameters":{"groupId":208}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Links | array | Output field: Links |
Links.file_name | string | Name of the resource |
Links.file | string | Output field: Links.file |
RequestedObject | object | Output field: RequestedObject |
RequestedObject.Id | number | Unique identifier |
RequestedObject.Name | string | Name of the resource |
RequestedObject.DisplayName | string | Name of the resource |
RequestedObject.Description | string | Output field: RequestedObject.Description |
RequestedObject.EveryoneFlag | boolean | Output field: RequestedObject.EveryoneFlag |
RequestedObject.Guid | string | Unique identifier |
RequestedObject.SystemFlag | boolean | Output field: RequestedObject.SystemFlag |
RequestedObject.LdapFlag | boolean | Output field: RequestedObject.LdapFlag |
RequestedObject.DomainId | object | Unique identifier |
RequestedObject.DistinguishedName | object | Name of the resource |
RequestedObject.DefaultHomeDashboardId | object | Unique identifier |
RequestedObject.DefaultHomeWorkspaceId | object | Unique identifier |
RequestedObject.UpdateInformation | object | Output field: RequestedObject.UpdateInformation |
RequestedObject.UpdateInformation.CreateDate | string | Date value |
RequestedObject.UpdateInformation.UpdateDate | string | Date value |
RequestedObject.UpdateInformation.CreateLogin | number | Output field: RequestedObject.UpdateInformation.CreateLogin |
RequestedObject.UpdateInformation.UpdateLogin | number | Output field: RequestedObject.UpdateInformation.UpdateLogin |
IsSuccessful | boolean | Whether the operation was successful |
ValidationMessages | array | Unique identifier |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"Links":[],"RequestedObject":{"Id":208,"Name":"Updated Group Name","DisplayName":"Updated Group Name","Description":"<html><head></head><p style=\"margin: 0px\">WAS: New Group Description</p></html>","EveryoneFlag":false,"Guid":"4eec52f1-bc2f-4460-ac2b-e6e179b5744d","SystemFlag":false,"LdapFlag":false,"DomainId":null,"DistinguishedName...
Get Record
Retrieve detailed information about a specific content record in an ArcherIRM application using the provided contentId.
Endpoint
- URL: /core/content/{{contentId}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.contentId | number | Required | The content record ID. |
Input Example
{"path_parameters":{"contentId":253379}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Archer | object | Output field: Archer |
Archer.Record | object | Output field: Archer.Record |
Archer.Record.Current Status | object | Status value |
Archer.Record.Current Status.OtherText | object | Status value |
Archer.Record.Current Status.ValuesListIds | array | Unique identifier |
Archer.Record.Date/Time Occurred | string | Output field: Archer.Record.Date/Time Occurred |
Archer.Record.Date/Time Reported | string | Output field: Archer.Record.Date/Time Reported |
Archer.Record.Days Open | number | Output field: Archer.Record.Days Open |
Archer.Record.Default Record Permissions | object | Output field: Archer.Record.Default Record Permissions |
Archer.Record.Default Record Permissions.GroupList | array | Output field: Archer.Record.Default Record Permissions.GroupList |
Archer.Record.Default Record Permissions.GroupList.HasDelete | boolean | Output field: Archer.Record.Default Record Permissions.GroupList.HasDelete |
Archer.Record.Default Record Permissions.GroupList.HasRead | boolean | Output field: Archer.Record.Default Record Permissions.GroupList.HasRead |
Archer.Record.Default Record Permissions.GroupList.HasUpdate | boolean | Date value |
Archer.Record.Default Record Permissions.GroupList.Id | number | Unique identifier |
Archer.Record.Default Record Permissions.UserList | array | Output field: Archer.Record.Default Record Permissions.UserList |
Archer.Record.Default Record Permissions.UserList.file_name | string | Name of the resource |
Archer.Record.Default Record Permissions.UserList.file | string | Output field: Archer.Record.Default Record Permissions.UserList.file |
Archer.Record.Google Map | string | Output field: Archer.Record.Google Map |
Archer.Record.Id | number | Unique identifier |
Archer.Record.Incident Details | string | Unique identifier |
Archer.Record.Incident Result | object | Unique identifier |
Archer.Record.Incident Result.OtherText | object | Unique identifier |
Archer.Record.Incident Result.ValuesListIds | array | Unique identifier |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"Archer":{"Record":{}}}}
Get User by ID
Retrieve a user's details from ArcherIRM using the specified user ID, requiring path parameters and headers.
Endpoint
- URL: /core/system/user/{{userid}}
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.userid | number | Required | ID of user content to be retrieved. |
headers | object | Required | HTTP headers for the request |
headers.X-Http-Method-Override | string | Required | POST is valid only if you include the X-Http-Method-Override:GET statement in the request header. |
Input Example
{"path_parameters":{"userid":1470},"headers":{"X-Http-Method-Override":"GET"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Links | array | Output field: Links |
Links.file_name | string | Name of the resource |
Links.file | string | Output field: Links.file |
RequestedObject | object | Output field: RequestedObject |
RequestedObject.Id | number | Unique identifier |
RequestedObject.DisplayName | string | Name of the resource |
RequestedObject.FirstName | string | Name of the resource |
RequestedObject.MiddleName | object | Unique identifier |
RequestedObject.LastName | string | Name of the resource |
RequestedObject.LastLoginDate | string | Date value |
RequestedObject.UserName | string | Name of the resource |
RequestedObject.AccountStatus | number | Status value |
RequestedObject.DomainId | object | Unique identifier |
RequestedObject.SecurityId | number | Unique identifier |
RequestedObject.Locale | object | Output field: RequestedObject.Locale |
RequestedObject.TimeZoneId | string | Unique identifier |
RequestedObject.Address | object | Output field: RequestedObject.Address |
RequestedObject.Company | object | Output field: RequestedObject.Company |
RequestedObject.Title | object | Output field: RequestedObject.Title |
RequestedObject.AdditionalNote | object | Output field: RequestedObject.AdditionalNote |
RequestedObject.BusinessUnit | object | Output field: RequestedObject.BusinessUnit |
RequestedObject.Department | object | Output field: RequestedObject.Department |
RequestedObject.ForcePasswordChange | boolean | Output field: RequestedObject.ForcePasswordChange |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"Links":[],"RequestedObject":{"Id":1470,"DisplayName":"Doe, John","FirstName":"John","MiddleName":null,"LastName":"Doe","LastLoginDate":"2016-09-13T15:16:18.35","UserName":"doej","AccountStatus":1,"DomainId":null,"SecurityId":1,"Locale":null,"TimeZoneId":"Eastern Standard Time","Address":null,"Company":null,"Title":null},"IsSuccessful"...
Retrieve Findings
Retrieve findings from ArcherIRM to analyze and manage risk-related data efficiently.
Endpoint
- URL: /contentapi/Findings
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.top | number | Optional | The number of findings to retrieve. |
Input Example
{"parameters":{"top":3}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
headers | object | HTTP headers for the request |
headers.cache-control | string | HTTP headers for the request |
headers.pragma | string | HTTP headers for the request |
headers.content-type | string | HTTP headers for the request |
headers.expires | string | HTTP headers for the request |
headers.x_csrf_token | string | HTTP headers for the request |
headers.odata-version | string | Response data |
headers.x-aspnet-version | string | HTTP headers for the request |
headers.x-frame-options | string | HTTP headers for the request |
headers.content-security-policy | string | HTTP headers for the request |
headers.x-content-type-options | string | HTTP headers for the request |
headers.permissions-policy | string | HTTP headers for the request |
headers.date | string | HTTP headers for the request |
headers.connection | string | HTTP headers for the request |
headers.content-length | string | HTTP headers for the request |
status_reason | string | Status value |
body | object | Request body data |
string | Response data | |
body.value | array | Request body data |
body.value.Findings_Id | number | Request body data |
body.value.AB_Action_Plan_Additional_Remediation_Ow | object | Request body data |
body.value.AB_Action_Plan_Audit_Committee_Update | object | Request body data |
body.value.AB_Action_Plan_EVP_and_SVP | object | Request body data |
body.value.AB_Control_Control_Owner | object | Request body data |
Output Example
{"status_code":200,"headers":{"cache-control":"no-cache","pragma":"no-cache","content-type":"application/json; odata.metadata=minimal; odata.streaming=true","expires":"-1","x_csrf_token":"cdgiUq7YE5dKFdTabd1E-tGYLVrrpNkRE6VA0O3-yoaH0k_zpBbSCQJ1StOOdAWKP6zeTM3tga26cLMl...","odata-version":"4.0","x-aspnet-version":"4.0.30319","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'","x-content-type-options":"nosniff","permissions-policy":"geolocation=(self), execution-while...
Search Records by Report ID or GUID.
Execute a search for records in ArcherIRM using a specific report ID or GUID, with pagination support. Requires reportIdOrGuid and pageNumber.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
reportIdOrGuid | string | Required | Internal ID or GUID of the report whose records you want to query. |
pageNumber | number | Required | Integer of the page (1,2,3,β¦,n) of search results to return. |
Input Example
{"reportIdOrGuid":"1580","pageNumber":10}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-10-21T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 21 Oct 2024 12:08:57 GMT","Cache-Control":"max-age=0, no-cache, no-store","Pragma":"no-cache","Date":"Mon, 21 Oct 2024 12:08:57 GMT"},"reason":"OK","json_body":{}}
Update Record
Update an existing content record in ArcherIRM using specified 'Content' details provided in the JSON body.
Endpoint
- URL: /core/content
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
Content | object | Optional | Response content |
Content.Id | number | Required | Unique identifier |
Content.LevelId | number | Required | Unique identifier |
Content.FieldContents | object | Required | Response content |
Content.FieldContents.3202 | object | Optional | Response content |
Content.FieldContents.3202.Type | number | Optional | Type of the resource |
Content.FieldContents.3202.Value | object | Optional | Value for the parameter |
Content.FieldContents.3202.Value.ValuesListIds | array | Optional | Unique identifier |
Content.FieldContents.3202.Value.OtherText | object | Optional | Value for the parameter |
Content.FieldContents.3202.FieldId | number | Optional | Unique identifier |
Content.FieldContents.3204 | object | Optional | Response content |
Content.FieldContents.3204.Type | number | Optional | Type of the resource |
Content.FieldContents.3204.Value | number | Optional | Value for the parameter |
Content.FieldContents.3204.FieldId | number | Optional | Unique identifier |
Content.FieldContents.10066 | object | Optional | Response content |
Content.FieldContents.10066.Type | number | Optional | Type of the resource |
Content.FieldContents.10066.Value | array | Optional | Value for the parameter |
Content.FieldContents.10066.FieldId | number | Optional | Unique identifier |
Content.Version | string | Optional | Response content |
SubformFieldId | number | Optional | Subform Field ID that must be passed when subform content is being saved. Otherwise, this parameter can be omitted. |
Input Example
{"json_body":{"Content":{"Id":123,"LevelId":9,"FieldContents":{"3202":{"Type":4,"Value":{"ValuesListIds":[2405],"OtherText":null},"FieldId":3202},"3204":{"Type":2,"Value":0,"FieldId":3204},"10066":{"Type":23,"Value":[150622],"FieldId":10066}},"Version":"44"},"SubformFieldId":123}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Links | array | Output field: Links |
Links.file_name | string | Name of the resource |
Links.file | string | Output field: Links.file |
RequestedObject | object | Output field: RequestedObject |
RequestedObject.Id | number | Unique identifier |
IsSuccessful | boolean | Whether the operation was successful |
ValidationMessages | array | Unique identifier |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"Links":[],"RequestedObject":{"Id":123454},"IsSuccessful":true,"ValidationMessages":["correct"]}}
Response Headers
Header | Description | Example |
|---|---|---|
Cache-Control | Directives for caching mechanisms | max-age=0, no-cache, no-store |
Content-Encoding | HTTP response header: Content-Encoding | gzip |
content-length | The length of the response body in bytes | 140 |
Content-Type | The media type of the resource | text/html; charset=utf-8 |
Date | The date and time at which the message was originated | Tue, 19 Dec 2023 20:37:23 GMT |
Expires | The date/time after which the response is considered stale | Mon, 21 Oct 2024 12:08:57 GMT |
Pragma | HTTP response header: Pragma | no-cache |
x-hsci-cache-time | HTTP response header: x-hsci-cache-time | 2024-10-21T12:01:22.328Z |