SysAid
This Integration is part of the SysAid Pack.#
Supported versions
Supported Cortex XSOAR versions: 6.0.0 and later.
SysAid is a robust IT management system designed to meet all of the needs of an IT department. This integration was integrated and tested with version 21.4.44 of SysAid.
Configure SysAid in Cortex#
Parameter | Description | Required |
---|---|---|
Server URL | True | |
Username | True | |
Password | True | |
Trust any certificate (not secure) | False | |
Use system proxy settings | False | |
Incident type | False | |
Maximum number of incidents to fetch | Maximum is limited to 200. | False |
Fetch incidents | False | |
First fetch time interval | False | |
Fetch types | Choose which service record type to fetch - incidents, requests, problems, changes, or all. | False |
Included statuses | A comma separated list of statuses to return. Default value includes "open classes". You may add/remove statuses according to your needs. The list of status numbers and their values can be retrieved by running the "sysaid-table-list" command with the "list_id=status" argument. | False |
Include Archived | False |
Commands#
You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
sysaid-table-list#
Retrieve all lists (tables) related to a specific entity, or a specific list from an entity.
Base Command#
sysaid-table-list
Input#
Argument Name | Description | Required |
---|---|---|
entity | A SysAid entity by which to retrieve the available lists. Defaults to service record. Options are: sr - Service record related lists, asset - Asset related lists, user - User related lists, ci - CI related lists, company - Company related lists, action_item - Action item related lists, project - Service record Sub Tabs lists, task - Task related lists, catalog - Catalog related lists, software - Software related lists, sr_activity - Service Record activity related lists, supplier - Supplier related lists, task_activity - Task activity related lists, user_groups - User Group related lists. Possible values are: sr, asset, user, ci, company, action_item, project, task, catalog, software, sr_activity, supplier, task_activity, user_groups. | Optional |
entity_id | The entity's ID. For example, in service record Form lists, send the service record ID to populate additional filters on the lists. For example, the responsibility list may be filtered by the admin group of the service record. | Optional |
entity_type | Numeric. For example, in sr entity, send the sr_type ID, for ci entity, send the ci type ID (for retrieving the list of CI sub-types). | Optional |
list_id | Desired list ID. | Optional |
key | Relevant for users/groups related fields. Defines whether to use the ID or the name as the key for each value in the result. Available values are "name" or "id". Defaults to "id". Possible values are: id, name. | Optional |
fields | A comma separated list of fields to return. Available fields are: id (always returned), caption, and values. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.List.id | String | The ID of the list. |
SysAid.List.caption | String | The caption of the list. |
SysAid.List.values | String | The values of the list. |
Command example#
!sysaid-table-list list_id=known_error
Context Example#
Human Readable Output#
List ID known_error Results:#
Id Caption Values known_error Known Error {'id': 'P', 'caption': 'Production'},
{'id': 'D', 'caption': 'Development'},
{'id': 'N', 'caption': 'No'}
sysaid-asset-list#
List all assets or get a specific asset by ID. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-asset-list
Input#
Argument Name | Description | Required |
---|---|---|
asset_id | The ID of the asset to return. | Optional |
fields | Comma separated list of fields to return to context data. The valid fields can be retrieved using the "sysaid-table-list" command with the "entity=asset" argument. You can send "all" for debugging purposes. | Required |
page_number | Index of the page of results to retrieve. Default is 1. | Optional |
page_size | The number of assets to return on a page. Default is 100. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.Asset.id | String | The ID of the asset. |
SysAid.Asset.name | String | The name of the asset. |
SysAid.Asset.info | String | The info of the asset. |
Command example#
!sysaid-asset-list fields=all
Context Example#
Human Readable Output#
Showing 100 results from page 1:
Asset Results:#
Id Name Info 0A-3E-E9-13-2B-E4 EC2AMAZ-S0GM752 Model: t3.large 5171019c-fa80-4905-a577-c95eb518de90 Test Phone Model: Galaxy S22,
Description: Test smartphone93c18412-a672-4a3d-8b02-6f91ee963918 Test LP Model: Dell Inspirion 3556,
Description: Test LP
sysaid-asset-search#
Get information about a specific asset. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-asset-search
Input#
Argument Name | Description | Required |
---|---|---|
query | The search criteria. | Required |
fields | Comma separated list of fields to return to context data. The valid fields can be retrieved using the "sysaid-table-list" command with the "entity=asset" argument. You can send "all" for debugging purposes. | Required |
page_size | The number of assets to return on a page. Default is 100. | Optional |
page_number | Index of the page of results to retrieve. Default is 1. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.Asset.id | String | The ID of the asset. |
SysAid.Asset.name | String | The name of the asset. |
SysAid.Asset.info | String | The info of the asset. |
Command example#
!sysaid-asset-search query=Test fields=all
Context Example#
Human Readable Output#
Showing 100 results from page 1:
Asset Results:#
Id Name Info 5171019c-fa80-4905-a577-c95eb518de90 Test Phone Model: Galaxy S22,
Description: Test smartphone93c18412-a672-4a3d-8b02-6f91ee963918 Test LP Model: Dell Inspirion 3556,
Description: Test LP
sysaid-filter-list#
List all filters. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-filter-list
Input#
Argument Name | Description | Required |
---|---|---|
fields | Comma separated list of fields to return to context data. You can send "all" for debugging purposes. | Required |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.Filter.id | String | The ID of the filter. |
SysAid.Filter.type | String | The type of the filter. |
SysAid.Filter.caption | String | The caption of the filter. |
SysAid.Filter.values | String | The values of the filter. |
Command example#
!sysaid-filter-list fields=all
Context Example#
Human Readable Output#
Filter Results:#
Id Caption Type Values priority Priority list ${list.all}: All,
1: Highest,
2: Very High,
3: High,
4: Normal,
5: Lowresponsibility Assigned to list 1: sysaid-dmst status Status list ${list.active}: Active,
${list.all}: All,
${list.close}: Closed Class,
1: New,
2: Open,
3: Closed,
4: Verified closed,
5: Pending,
6: Postponed,
7: Deleted,
8: Reopened by End User,
18: Change opened and being analyzed,
19: Change Approved,
20: Change Rejected,
21: Change Completed,
22: Being Analyzed,
23: In Approval Process,
24: In Implementation,
25: In Release,
26: Waiting to be closed,
27: Problem Identified,
28: Problem Solved,
29: Closed unresolved problem,
30: Analyzing the solution for the problem,
31: User Responded,
32: Pending Problem resolution,
33: Request opened and being analyzed,
34: Request Completed,
35: Request Rejected,
36: Request Cancelled,
39: Merge Deleted,
40: Merge Closedurgency Urgency list ${list.all}: All,
1: Urgent,
2: Very High,
3: High,
4: Normal,
5: Lowrequest_user Request user list 3: Adi Dmst,
1: sysaid-dmst,
2: Test Userproblem_type Category nested problem_type: problem_type archive Archive boolean assigned_group Admin Group list ${list.group.all}: All Groups,
${list.group.none}: none,
1: Support
sysaid-user-list#
Get list of users in SysAid. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-user-list
Input#
Argument Name | Description | Required |
---|---|---|
fields | Comma separated list of fields to return to context data. The valid fields can be retrieved using the "sysaid-table-list" command with the "entity=user" argument. You can send "all" for debugging purposes. | Required |
type | The user type to retrieve. Defaults to all user types if not specified. Possible values are: admin, user, manager. | Optional |
page_number | Index of the page of results to retrieve. Default is 1. | Optional |
page_size | The number of users to return on a page. Default is 100. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.User.id | String | The ID of the user. |
SysAid.User.name | String | The name of the user. |
SysAid.User.isAdmin | Boolean | Whether the SysAid user is an admin or not. |
SysAid.User.isSysAidAdmin | Boolean | Whether the SysAid user is a SysAid admin or not. |
SysAid.User.isManager | Boolean | Whether the SysAid user is a manager or not. |
SysAid.User.isGuest | Boolean | Whether the SysAid user is a guest or not. |
Command example#
!sysaid-user-list fields=all
Context Example#
Human Readable Output#
Showing 100 results from page 1:
Filter Results:#
id name isAdmin isManager isSysAidAdmin isGuest 3 sysaid-adi-dmst false false false false 1 sysaid-dmst true true true false 2 Test-User false false false false
sysaid-user-search#
Get information about a specific asset. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-user-search
Input#
Argument Name | Description | Required |
---|---|---|
query | The search criteria. | Required |
fields | Comma separated list of fields to return to context data. The valid fields can be retrieved using the "sysaid-table-list" command with the "entity=user" argument. You can send "all" for debugging purposes. | Required |
type | The user types to retrieve. Defaults to all user types if not specified. Possible values are: admin, user, manager. | Optional |
page_number | Index of the page of results to retrieve. Default is 1. | Optional |
page_size | The number of users to return on a page. Default is 100. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.User.id | String | The ID of the user. |
SysAid.User.name | String | The name of the user. |
SysAid.User.isAdmin | Boolean | Whether the SysAid user is an admin or not. |
SysAid.User.isSysAidAdmin | Boolean | Whether the SysAid user is a SysAid admin or not. |
SysAid.User.isManager | Boolean | Whether the SysAid user is a manager or not. |
SysAid.User.isGuest | Boolean | Whether the SysAid user is a guest or not. |
Command example#
!sysaid-user-search query=dmst fields=all
Context Example#
Human Readable Output#
Showing 100 results from page 1:
User Results:#
id name isAdmin isManager isSysAidAdmin isGuest 3 sysaid-adi-dmst false false false false 1 sysaid-dmst true true true false
sysaid-service-record-list#
List all service requests. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-service-record-list
Input#
Argument Name | Description | Required |
---|---|---|
type | The requested service record type. Possible values are: incident, request, problem, change, all. | Required |
fields | Comma separated list of fields to return to context data. You can send "all" for debugging purposes. | Required |
page_number | Index of the page of results to retrieve. Default is 1. | Optional |
page_size | The number of service records to return on a page. Default is 100. | Optional |
ids | The list of service records IDs to return, comma separated. | Optional |
archive | Whether to return archived service records. Possible values are: 0, 1. | Optional |
custom_fields_keys | Comma separated list of filters' IDs. | Optional |
custom_fields_values | Comma separated list of the values of the filters' IDs. For example, custom_fields_keys:key1,key2, custom_fields_values:value1,value2. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.ServiceRecord.id | String | The ID of the service record. |
SysAid.ServiceRecord.title | String | The title of the service record. |
SysAid.ServiceRecord.status | String | The status of the service record. |
SysAid.ServiceRecord.update_time | Date | The modify time of the service record. |
SysAid.ServiceRecord.sr_type | String | The type of the service record. |
SysAid.ServiceRecord.notes | String | The notes of the service record. |
Command example#
!sysaid-service-record-list type=all fields=all
Context Example#
Human Readable Output#
Showing 100 results from page 1:
Service Record Results:#
Id Title Status Modify Time Service Record Type 25 Cannot access email - Test New 03/15/2022 04:53:20 AM Incident 28 Cannot connect to a Wi-Fi network New 03/07/2022 09:08:01 AM Incident 33 Try Test New 03/20/2022 11:08:56 AM Incident 34 try arc New 03/22/2022 05:05:28 AM Incident 26 Paper jam - Test Open 03/20/2022 07:56:41 AM Incident 6 Welcome to SysAid! Closed 03/31/2022 10:16:10 AM Incident 30 Standard Change Process New 03/07/2022 09:12:25 AM Change 36 Minor Problem try New 03/27/2022 09:24:29 AM Problem 27 Install Adobe Acrobat Reader - Test New 03/07/2022 08:59:23 AM Request 29 Permissions to use printer New 03/07/2022 09:08:36 AM Request 31 Reset my password New 03/07/2022 09:13:39 AM Request 35 Advanced Request Process try New 03/27/2022 09:23:57 AM Request 37 Basic Request Process2 New 03/30/2022 01:56:47 AM Request
sysaid-service-record-search#
Search by a query through all service records. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-service-record-search
Input#
Argument Name | Description | Required |
---|---|---|
type | The requested service record type. Possible values are: incident, request, problem, change, all. | Required |
fields | Comma separated list of fields to return to context data. You can send "all" for debugging purposes. | Required |
page_number | Index of the page of results to retrieve. Default is 1. | Optional |
page_size | The number of service records to return on a page. Default is 100. | Optional |
query | The search criteria. | Required |
archive | Whether to return archived service records. Possible values are: 0, 1. | Optional |
custom_fields_keys | Comma separated list of filters' IDs. | Optional |
custom_fields_values | Comma separated list of the values of the filters' IDs. For example, custom_fields_keys:key1,key2, custom_fields_values:value1,value2. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.ServiceRecord.id | String | The ID of the service record. |
SysAid.ServiceRecord.title | String | The title of the service record. |
SysAid.ServiceRecord.status | String | The status of the service record. |
SysAid.ServiceRecord.update_time | Date | The modify time of the service record. |
SysAid.ServiceRecord.sr_type | String | The type of the service record. |
SysAid.ServiceRecord.notes | String | The notes of the service record. |
Command example#
!sysaid-service-record-search type=all query=test fields=all
Context Example#
Human Readable Output#
Showing 100 results from page 1:
Service Record Results:#
Id Title Status Modify Time Service Record Type 25 Cannot access email - Test New 03/15/2022 04:53:20 AM Incident 28 Cannot connect to a Wi-Fi network New 03/07/2022 09:08:01 AM Incident 33 Try Test New 03/20/2022 11:08:56 AM Incident 26 Paper jam - Test Open 03/20/2022 07:56:41 AM Incident 30 Standard Change Process New 03/07/2022 09:12:25 AM Change 27 Install Adobe Acrobat Reader - Test New 03/07/2022 08:59:23 AM Request 29 Permissions to use printer New 03/07/2022 09:08:36 AM Request 31 Reset my password New 03/07/2022 09:13:39 AM Request 37 Basic Request Process2 New 03/30/2022 01:56:47 AM Request
sysaid-service-record-update#
The valid statuses can be retrieved using the "sysaid-table-list" command.
Base Command#
sysaid-service-record-update
Input#
Argument Name | Description | Required |
---|---|---|
id | The service record ID. | Required |
impact | The new impact of the service record. | Optional |
priority | The new priority of the service record. | Optional |
status | The new status of the service record. | Optional |
description | The new description of the service record. | Optional |
solution | The new solution of the service record. | Optional |
problem_type | The new problem type of the service record. | Optional |
problem_sub_type | The new problem sub-type of the service record. | Optional |
third_level_category | The new third level category of the service record. | Optional |
sr_type | The new service record type of the service record. | Optional |
sub_type | The new sub-type of the service record. | Optional |
agreement | The new agreement of the service record. | Optional |
title | The new title of the service record. | Optional |
followup_user | The new follow up user of the service record. | Optional |
followup_text | The new follow up text of the service record. | Optional |
cust_notes | The new custom notes of the service record. | Optional |
email_account | The new email account of the service record. | Optional |
responsibility | The new responsibility of the service record. | Optional |
urgency | The new urgency of the service record. | Optional |
company | The new company of the service record. | Optional |
department | The new department of the service record. | Optional |
computer_id | The new computer ID of the service record. | Optional |
due_date | The new due date of the service record. | Optional |
escalation | The new escalation of the service record. | Optional |
change_category | The new change category of the service record. | Optional |
assigned_group | The new assigned group of the service record. | Optional |
location | The new location of the service record. | Optional |
custom_fields_keys | Comma separated list of filters' IDs. | Optional |
custom_fields_values | Comma separated list of the values of the filters' IDs. For example, custom_fields_keys:key1,key2, custom_fields_values:value1,value2. | Optional |
Context Output#
There is no context output for this command.
Command example#
!sysaid-service-record-update id=6 status=2
Human Readable Output#
Service Record 6 Updated Successfully.
sysaid-service-record-close#
Close a service record. Sets the service record status to the default Close status, as defined in the Help Desk settings.
Base Command#
sysaid-service-record-close
Input#
Argument Name | Description | Required |
---|---|---|
id | The service record ID. | Required |
solution | The solution for closing the service record. | Optional |
Context Output#
There is no context output for this command.
Command example#
!sysaid-service-record-close id=6 solution="Closing via API call"
Human Readable Output#
Service Record 6 Closed Successfully.
sysaid-service-record-template-get#
Gets the template of a service record. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-service-record-template-get
Input#
Argument Name | Description | Required |
---|---|---|
fields | Comma separated list of fields to return to context data. The valid fields can be retrieved using the "sysaid-table-list" command with the "entity=sr" argument. You can send "all" for debugging purposes. | Required |
type | The requested service record type. Possible values are: incident, request, problem, change. | Required |
template_id | The service record template ID, according to service record type. Defaults to the first/default template. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.ServiceRecordTemplate.key | String | The key of the service record template entry. |
SysAid.ServiceRecordTemplate.value | String | The value of the service record template entry. |
SysAid.ServiceRecordTemplate.mandatory | String | Whether the template entry is mandatory or not. |
SysAid.ServiceRecordTemplate.editable | Boolean | Whether the template entry is editable or not. |
SysAid.ServiceRecordTemplate.type | Boolean | The type of the service record template entry. |
SysAid.ServiceRecordTemplate.defaultValue | String | The default value of the service record template entry. |
SysAid.ServiceRecordTemplate.keyCaption | String | The key caption of the service record template entry. |
Command example#
!sysaid-service-record-template-get type=incident fields=all
Context Example#
Human Readable Output#
Service Record Results:#
Key Value Mandatory Editable Type Key Caption third_level_category false true list Third Level Category cust_list1 0 false true list SR Custom List 1 notes false true object Notes screen sendScreenCapture: NO
captureExists: falsefalse true object Screen capture resolution false true text Resolution childs false true object Child Service Records cust_list2 0 false true list SR Custom List 2 parent_link 0 false true numeric Parent ID solution false true text Solution project_id false true object Main project links false true object Links sr_weight 0 false true numeric Weight followup_planned_date false true date Followup Planned Date cust_int2 0 false true numeric SR Custom Int 2 cust_date1 false true date SR Custom Date 1 cust_int1 0 false true numeric SR Custom Int 1 impact 4 false true list Impact cust_date2 false true date SR Custom Date 2 priority 5 false true list Priority merged_service_records false true text Merged service records CustomColumn3sr false true text Test Field messages false true object Messages problem_type false true nested Category alertID false true calculated Alert actions false true object Actions status 1 false true list Status attachments false true object Attachments problem_sub_type false true list Sub-Category linkedSRs false true object Links to other Items description false true text Description task_id 0 false true numeric Main task video sendVideoRecording: NO
captureExists: false
filePath: nullfalse true object Video capture title DEFAULT false true text Title followup_user false true list Followup User workaround false true text Workaround success_rating 0 false true numeric Success Rating cust_notes false true text SR Custom Notes followup_text false true text Followup Text responsibility 1 false true list Assigned to urgency 5 false true list Urgency request_user 1 false true list Request user sub_type 6 false true list Sub Type company 0 false true list Company followup_actual_date false true date Followup Actual Date computer_id false true text Asset ID cc false true list CC ci 0 false true list Main CI due_date false true date Due Date cust_text1 false true text SR Custom Text 1 cust_text2 false true text SR Custom Text 2 merged_to 0 false true numeric Merged to responsible_manager false true list Responsible Admin solutionModel false true object Solution Model activities false true object Activities relatedProblems false true object Potential Related Problems change_category 0 false true list Classification assigned_group false true list Admin group location false true list Location sr_type 2 false true list Service Record Type
sysaid-service-record-create#
Create a new service record and return the newly created service record. The valid statuses can be retrieved using the "sysaid-table-list" command. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-service-record-create
Input#
Argument Name | Description | Required |
---|---|---|
fields | Comma separated list of fields to return to context data. The valid fields can be retrieved using the "sysaid-table-list" command with the "entity=sr" argument. You can send "all" for debugging purposes. | Required |
type | The requested service record type. Possible values are: incident, request, problem, change. | Required |
template_id | The service record template ID, according to service record type. Defaults to the first/default template. | Optional |
description | The new description of the service record. | Required |
title | The new title of the service record. | Required |
impact | The new impact of the service record. | Optional |
priority | The new priority of the service record. | Optional |
status | The new status of the service record. | Optional |
solution | The new solution of the service record. | Optional |
problem_type | The new problem type of the service record. | Optional |
problem_sub_type | The new problem sub-type of the service record. | Optional |
third_level_category | The new third level category of the service record. | Optional |
sr_type | The new service record type of the service record. | Optional |
sub_type | The new sub-type of the service record. | Optional |
agreement | The new agreement of the service record. | Optional |
followup_user | The new follow up user of the service record. | Optional |
followup_text | The new follow up text of the service record. | Optional |
cust_notes | The new custom notes of the service record. | Optional |
email_account | The new email account of the service record. | Optional |
responsibility | The new responsibility of the service record. | Optional |
urgency | The new urgency of the service record. | Optional |
company | The new company of the service record. | Optional |
department | The new department of the service record. | Optional |
computer_id | The new computer ID of the service record. | Optional |
due_date | The new due date of the service record. | Optional |
escalation | The new escalation of the service record. | Optional |
change_category | The new change category of the service record. | Optional |
assigned_group | The new assigned group of the service record. | Optional |
location | The new location of the service record. | Optional |
custom_fields_keys | Comma separated list of filters' IDs. | Optional |
custom_fields_values | Comma separated list of the values of the filters' IDs. For example, custom_fields_keys:key1,key2, custom_fields_values:value1,value2. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.ServiceRecord.id | String | The ID of the service record. |
SysAid.ServiceRecord.title | String | The title of the service record. |
SysAid.ServiceRecord.status | String | The status of the service record. |
SysAid.ServiceRecord.update_time | Date | The modify time of the service record. |
SysAid.ServiceRecord.sr_type | String | The type of the service record. |
SysAid.ServiceRecord.notes | String | The notes of the service record. |
Command example#
!sysaid-service-record-create type=request description="This is a test" title="Test SR from API" sr_type=6 fields=all
Context Example#
Human Readable Output#
Service Record Results:#
Id Title Status Service Record Type Notes 0 Basic Request Process New Request Template If relevant, add this Request details to the Knowledge base. Close the Request.
sysaid-service-record-delete#
Delete one or more service records.
Base Command#
sysaid-service-record-delete
Input#
Argument Name | Description | Required |
---|---|---|
ids | The service record ID. | Required |
solution | The solution for deleting the service record. | Optional |
Context Output#
There is no context output for this command.
Command example#
!sysaid-service-record-delete ids=2,32
Human Readable Output#
Service Records 2,32 Deleted Successfully.
sysaid-service-record-attach-file#
Add an attachment to a service record.
Base Command#
sysaid-service-record-attach-file
Input#
Argument Name | Description | Required |
---|---|---|
id | The service record ID. | Required |
file_id | File file ID to upload. | Required |
Context Output#
There is no context output for this command.
Command example#
!sysaid-service-record-attach-file file_id=110@51d40811-801a-4b26-8861-68474c40b347 id=25
Human Readable Output#
File uploaded to Service Record 25 successfully.
sysaid-service-record-get-file#
Download an attachment to a service record.
Base Command#
sysaid-service-record-get-file
Input#
Argument Name | Description | Required |
---|---|---|
id | The service record ID. | Required |
file_id | The ID of the file to download. | Required |
file_name | The full name with extension of the file to be downloaded. | Required |
Context Output#
Path | Type | Description |
---|---|---|
File.Size | Integer | The size of the file. |
File.SHA1 | String | The SHA1 of the file. |
File.SHA256 | String | The SHA256 of the file. |
File.SHA512 | String | The SHA512 of the file. |
File.Name | String | The full name with extension of the file. |
File.SSDeep | String | The SSDeep of the file. |
File.EntryID | String | The entryId of the file. |
File.Info | String | The info of the file. |
File.Type | String | The type of the file. |
File.MD5 | String | The MD5 of the file. |
File.Extension | String | The extension of the file. |
Command example#
!sysaid-service-record-get-file file_id="-80357423_-1872498142" id=37 file_name="file_name.png"
Context Example#
Human Readable Output#
There is no human readable output for this command.
sysaid-service-record-delete-file#
Delete an attachment from a service record.
Base Command#
sysaid-service-record-delete-file
Input#
Argument Name | Description | Required |
---|---|---|
id | The service record ID. | Required |
file_id | The attachment file ID to delete. | Required |
Context Output#
There is no context output for this command.
Command example#
!sysaid-service-record-delete-file id=25 file_id=534492489_354835714
Human Readable Output#
File deleted from Service Record 25 successfully.
sysaid-service-record-get#
Returns the information for the specified service record.
Base Command#
sysaid-service-record-get
Input#
Argument Name | Description | Required |
---|---|---|
id | The service record ID. | Required |
fields | List of fields to return, comma separated. If sent together with view parameter, returns both view’s fields and the requested fields. | Required |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.ServiceRecord.id | String | The ID of the service record. |
SysAid.ServiceRecord.title | String | The title of the service record. |
SysAid.ServiceRecord.status | String | The status of the service record. |
SysAid.ServiceRecord.update_time | Date | The modify time of the service record. |
SysAid.ServiceRecord.sr_type | String | The type of the service record. |
SysAid.ServiceRecord.notes | String | The notes of the service record. |
Command example#
!sysaid-service-record-get id=25 fields=all
Context Example#
Human Readable Output#
Service Record Results:#
Id Title Status Modify Time Service Record Type Notes 25 Cannot access email - Test New 04/19/2023 05:48:02 AM Incident sysaid-dmst (04/19/2023 05:48 AM):
Note
,
sysaid-dmst (04/19/2023 05:34 AM):
this is a new note
,
sysaid-dmst (03/10/2022 12:59:20):
THis is a note
Service Record Results:#
Id | 37 |
Title | Basic Request Process2 |
Status | New |
Modify Time | 03/30/2022 01:56:47 AM |
Service Record Type | Request |
Notes | If relevant, add this Request details to the Knowledge base. Close the Request. |
sysaid-service-record-add-note#
Add a note to a Service Record
Base Command#
sysaid-service-record-add-note
Input#
Argument Name | Description | Required |
---|---|---|
id | The service record ID. | Required |
note | The note to be added to the Service Record. | Required |
Context Output#
There is no context output for this command.
Command example#
``!sysaid-service-record-add-note id=25 note=
this is a new note````
Human Readable Output#
Updated record with new note