# SysAid

> Manage SysAid service records, companies and assets, look up staff, and watch new or changed records.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/sysaid

## Actions

### Create asset

Create asset.

**Inputs**

- Name (`name`, text, required): The name of the asset.
- Type (`type`, text, required): The asset type (Laptop / Smartphone / etc.).
- Source (`source`, text): The origin of the asset, describing how it was added to the system.
- Manufacturer (`manufacturer`, text): The manufacturer of the asset.
- Model (`model`, text): The model of the asset.
- Serial (`serial`, text): The asset's serial number according to the manufacturer.
- Description (`description`, text): The description of the asset.
- Is disabled (`is_disabled`, true/false): Indicates whether the asset is disabled. When true, automatic inventory updates, monitoring, and all other SysAid Agent capabilities are turned off for the asset.
- Owner ID (`owner_id`, number): The unique ID of the user who owns the asset.
- Ownership (`ownership`, text): Defines who is the official owner of the asset - the employee or the company. One of: `personal`, `company`.
- Company (`company_id`, number): The unique ID of the company the asset belongs to.
- Location ID (`location_id`, number): The unique ID of the asset’s location.
- Department ID (`department_id`, number): The unique ID of the department the asset belongs to.
- Warranty expiration (`warranty_expiration`, date): The date when the asset’s warranty expires.
- Patch management enabled (`patch_management_enabled`, true/false): Indicates if patch management is enabled for the asset. To learn more, see SysAid Patch Management Guide.
- Os (`os`, object): Operating System properties.
- Network (`network`, object): Network properties.
- Custom fields (`custom_fields`, object): Custom fields.
- Additional data (`additional_data`, text): Additional data available for the asset.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": "MSI-123",
    "success": true
  }
}
```

### Create company

Create company.

**Inputs**

- Name (`name`, text, required): Name.
- Address (`address`, text): Main company address.
- Address2 (`address2`, text): Additional company address.
- City (`city`, text): The city in which the company is located.
- State (`state`, text): The state in which the company is located.
- Zip (`zip`, text): The company's zip code.
- Country (`country`, text): The country in which the company is located.
- Phone (`phone`, text): The company’s phone number.
- Fax (`fax`, text): The company’s fax number.
- Notes (`notes`, text): Notes related to the company.
- Email account (`email_account`, text): Default email account.
- Expiration date (`expiration_date`, date): The date when the company's access to the help will expire.
- Agreement ID (`agreement_id`, number): The ID of the SLA applied to the company.
- Agreement start date (`agreement_start_date`, date): The start date of your service agreement with the company.
- Agreement end date (`agreement_end_date`, date): The end date of your service agreement with the company.
- Custom fields (`custom_fields`, object): Company custom fields.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 100
  }
}
```

### Create service record

Create service record.

**Inputs**

- Template ID (`template_id`, number): Template ID.
- Type (`type`, text, required): Type. One of: `incident`, `problem`, `request`, `change`.
- Change category (`change_category`, number): The classification or severity level id of the service record (relevant only for service requests of Change type and depends on the account).
- Description (`description`, text): A detailed description of the service record.
- Due date (`due_date`, date and time): The date by which the service record is expected to be resolved.
- Impact (`impact`, number): The impact level of the service record, indicating its effect on operations.
- Asset (`asset_id`, text): The primary asset id associated with the service record.
- Ci ID (`ci_id`, number): The main configuration item (CI) id related to the service record.
- Priority (`priority`, number): The priority id level of the service record.
- Status (`status`, number): The current status id of the service record (e.g., Open, Closed, Pending). Depends on an account.
- Title (`title`, text, required): The title or subject of the service record.
- Urgency (`urgency`, number): The urgency level of the service record, indicating how quickly it should be addressed.
- Weight (`weight`, number): A numerical value that may indicate the relative importance or complexity of the service record.
- Sr sub type (`sr_sub_type`, number): Service record subtype.
- Location (`location`, number): Unique id of the location associated with the service record.
- Cust int1 (`cust_int1`, number): Custom value 1.
- Cust int2 (`cust_int2`, number): Custom value 1.
- Cust date1 (`cust_date1`, date and time): Custom date 1.
- Cust date2 (`cust_date2`, date and time): Custom date 1.
- Cust notes (`cust_notes`, text): Custom notes.
- Cust text1 (`cust_text1`, text): Custom text 1.
- Cust text2 (`cust_text2`, text): Custom text 2.
- Cust list1 (`cust_list1`, number): Custom list 1 integer identifier.
- Cust list2 (`cust_list2`, number): Custom list 1 integer identifier.
- Parent link (`parent_link`, number): Parent link.
- Workaround (`workaround`, text): Workaround.
- Task ID (`task_id`, number): Task ID.
- Project ID (`project_id`, number): Project ID.
- Version (`version`, number): Version.
- Success rating (`success_rating`, number): Success rating.
- Followup text (`followup_text`, text): Followup text.
- Followup actual date (`followup_actual_date`, date and time): Followup actual date.
- Followup planned date (`followup_planned_date`, date and time): Followup planned date.
- Cc (`cc`, text): Cc.
- Primary category (`primary_category`, number): First level service record category id.
- Secondary category (`secondary_category`, number): Second level service record category id.
- Third level category (`third_level_category`, number): Third level service record category id.
- Assigned group (`assigned_group`, text): Name of the administrative group responsible for managing the service record.
- Assignee (`assignee`, text): Username of the user to whom the service record is assigned.
- Request user (`request_user`, text): Username of the user who originally requested the service record.
- Followup user (`followup_user`, text): Username of the user who follows up the service record's changes.
- Responsible manager (`responsible_manager`, text): Admin username who manages the service record.
- Custom columns fields (`custom_columns_fields`, object): Custom columns fields.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 1779,
    "version": 1
  }
}
```

### Delete asset

Delete asset.

**Inputs**

- Id (`id`, text, required): The unique identifier of the asset in SysAid.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Delete company

Delete company.

**Inputs**

- Company (`company_id`, number, required): The unique identifier of the company in SysAid.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Delete service record

Delete service record.

**Inputs**

- Record (`record_id`, number, required): The service record's unique SysAid ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Get agent

Get agent.

**Inputs**

- Id (`id`, number, required): The agent's unique SysAid ID.
- Expand (`expand`, list): Include additional related data in the response for the selected entity/entities. One or more of: `groups`, `company`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 342,
    "version": 13
  }
}
```

### Get asset

Get asset.

**Inputs**

- Id (`id`, text, required): The unique identifier of the asset in SysAid.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": "MSI-123",
    "name": "KATANA-GF66",
    "version": 1
  }
}
```

### Get company

Get company.

**Inputs**

- Company (`company_id`, number, required): The unique identifier of the company in SysAid.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 1,
    "name": "Alpha",
    "version": 5
  }
}
```

### Get end user

Get end user.

**Inputs**

- Id (`id`, number, required): The end user's unique SysAid ID.
- Expand (`expand`, list): Include additional related data in the response for the selected entity/entities. One or more of: `groups`, `company`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 342,
    "version": 13
  }
}
```

### Get service record

Get service record.

**Inputs**

- Record (`record_id`, number, required): The unique ID of the service record
- Fields (`fields`, list): A comma-separated list of service record fields to return in response.
- Expand (`expand`, list): Names of service record property to expand. One or more of: `company`, `requestUser`, `ci`, `asset`, `category`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 1779,
    "version": 1
  }
}
```

### List agents

List agents.

**Inputs**

- Limit (`limit`, number): The numbder of items to display per page. The deafult is 20 and you can have up to 500. From 1 to 500.
- Offset (`offset`, number): The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1). At least 0.
- Query (`query`, text): Query to search by username, first name, last name, email or phone.
- Expand (`expand`, list): Include additional related data in the response for the selected entity/entities. One or more of: `groups`, `company`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List assets

List assets.

**Inputs**

- Limit (`limit`, number): The number of records to return per page, up to 500. From 1 to 500.
- Offset (`offset`, number): The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1). At least 0.
- Sort by (`sort_by`, text): An asset field to sort by. One of: `id`, `name`, `type`, `manufacturer`, `model`, `serial`, `ownerId`, `source`, `ownership`, `companyId`, and 4 more.
- Sort dir (`sort_dir`, text): Assets sorting direction. One of: `asc`, `desc`.
- Query (`query`, text): A string by which assets are searched. The search is made in the following asset properties: name, description and additionalData.
- Id (`id`, list): Assets id filter.
- Source (`source`, list): Assets source filter.
- Ownership (`ownership`, list): Assets ownership filter. One or more of: `personal`, `company`, `none`.
- Is disabled (`is_disabled`, true/false): Assets disablement status filter.
- Owner ID (`owner_id`, list): Assets owner ids filter.
- Name (`name`, text): Assets name filter.
- Type (`type`, text): Assets type filter.
- Description (`description`, text): Assets description filter.
- Ip addresses (`ip_addresses`, text): Assets IP addresses filter.
- Mac addresses (`mac_addresses`, text): Assets MAC addresses filter
- Manufacturer (`manufacturer`, text): Assets manufacturer name filter.
- Model (`model`, text): Assets model name filter.
- Serial (`serial`, text): Assets model name filter.
- Company (`company_id`, list): Assets company id filter.
- Department ID (`department_id`, list): Assets department id filter.
- Location ID (`location_id`, list): Assets location id filter.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List companies

List companies.

**Inputs**

- Limit (`limit`, number): The number of items to display per page. The default is 100, and you can have up to 500. From 1 to 500.
- Offset (`offset`, number): The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1). At least 0.
- Query (`query`, text): The string by which to search companies.
- Name (`name`, text): The name (partial or whole) companies filter.
- Id (`id`, list): The ID companies filter.
- State (`state`, text): The state (partial or whole) companies filter.
- City (`city`, text): The city (partial or whole) companies filter.
- Country (`country`, text): The country (partial or whole) companies filter.
- Address (`address`, text): The address (partial or whole) companies filter.
- Agreement ID (`agreement_id`, list): The agreement ID companies filter.
- Sort by (`sort_by`, text): The property by which companies are sorted. One of: `id`, `name`, `address`, `address2`, `city`, `state`, `country`, `zip`, `phone`, `fax`, and 5 more.
- Sort dir (`sort_dir`, text): The direction in which companies are sorted. One of: `asc`, `desc`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List end users

List end users.

**Inputs**

- Limit (`limit`, number): The numbder of items to display per page. The deafult is 20 and you can have up to 500. From 1 to 500.
- Offset (`offset`, number): The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1). At least 0.
- Query (`query`, text): Query to search by username, first name, last name, email or phone.
- Expand (`expand`, list): Include additional related data in the response for the selected entity/entities. One or more of: `groups`, `company`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List groups

List groups.

**Inputs**

- Limit (`limit`, number): The numbder of items to display per page. The deafult is 20 and you can have up to 500. From 1 to 500.
- Offset (`offset`, number): The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1). At least 0.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List service records

List service records.

**Inputs**

- Fields (`fields`, list): A comma-separated list of fields to return in service records.
- Query (`query`, text): The search criteria
- Offset (`offset`, number): SR count is limited (see limit parameter). This parameter specifies the offset (start point) from which to retrieve values (e.g. 25). Defaults to 0.
- Limit (`limit`, number): The maximum number of SRs to retrieve per request. Defaults to 100 results (configurable). At most 100.
- Sort by (`sort_by`, list): One or more fields to sort by. Available fields are those that were fetched by the request.
- Sort dir (`sort_dir`, text): Sort order: ascending or descending. Available values: asc/desc. Default is 'asc'. Relevant only when sort parameter is sent. One of: `asc`, `desc`.
- Expand (`expand`, list): Names of service record property to expand. One or more of: `company`, `requestUser`, `ci`, `asset`, `category`.
- Filters (`filters`, object): List of key-value parameters with {filter.id} as the key. and {filter.values.id} as the value. I.e.: …&status=19&request_user=235. Multiple values can be sent, comma-separated. I.e.: …&status=4,5.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### Update asset

Update asset.

**Inputs**

- Id (`id`, text, required): The unique identifier of the asset in SysAid.
- Name (`name`, text): The name of the asset.
- Type (`type`, text): The asset type (Laptop / Smartphone / etc.).
- Source (`source`, text): The origin of the asset, describing how it was added to the system.
- Manufacturer (`manufacturer`, text): The manufacturer of the asset.
- Model (`model`, text): The model of the asset.
- Serial (`serial`, text): The asset's serial number according to the manufacturer.
- Description (`description`, text): The description of the asset.
- Is disabled (`is_disabled`, true/false): Indicates whether the asset is disabled. When true, automatic inventory updates, monitoring, and all other SysAid Agent capabilities are turned off for the asset.
- Owner ID (`owner_id`, number): The unique ID of the user who owns the asset.
- Ownership (`ownership`, text): Defines who is the official owner of the asset - the employee or the company. One of: `personal`, `company`.
- Company (`company_id`, number): The unique ID of the company the asset belongs to.
- Location ID (`location_id`, number): The unique ID of the asset’s location.
- Department ID (`department_id`, number): The unique ID of the department the asset belongs to.
- Warranty expiration (`warranty_expiration`, date): The date when the asset’s warranty expires.
- Patch management enabled (`patch_management_enabled`, true/false): Indicates if patch management is enabled for the asset. To learn more, see SysAid Patch Management Guide.
- Os (`os`, object): Operating System properties.
- Network (`network`, object): Network properties.
- Custom fields (`custom_fields`, object): Custom fields.
- Additional data (`additional_data`, text): Additional data available for the asset.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "success": true
  }
}
```

### Update company

Update company.

**Inputs**

- Company (`company_id`, number, required): The unique identifier of the company in SysAid.
- Name (`name`, text): Name.
- Address (`address`, text): Main company address.
- Address2 (`address2`, text): Additional company address.
- City (`city`, text): The city in which the company is located.
- State (`state`, text): The state in which the company is located.
- Zip (`zip`, text): The company's zip code.
- Country (`country`, text): The country in which the company is located.
- Phone (`phone`, text): The company’s phone number.
- Fax (`fax`, text): The company’s fax number.
- Notes (`notes`, text): Notes related to the company.
- Email account (`email_account`, text): Default email account.
- Expiration date (`expiration_date`, date): The date when the company's access to the help will expire.
- Agreement ID (`agreement_id`, number): The ID of the SLA applied to the company.
- Agreement start date (`agreement_start_date`, date): The start date of your service agreement with the company.
- Agreement end date (`agreement_end_date`, date): The end date of your service agreement with the company.
- Custom fields (`custom_fields`, object): Company custom fields.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 1,
    "name": "Alpha",
    "version": 5
  }
}
```

### Update service record

Update service record.

**Inputs**

- Record (`record_id`, number, required): The service record's unique SysAid ID.
- Change category (`change_category`, number): The classification or severity level id of the service record (relevant only for service requests of Change type and depends on the account).
- Description (`description`, text): A detailed description of the service record.
- Due date (`due_date`, date and time): The date by which the service record is expected to be resolved.
- Impact (`impact`, number): The impact level of the service record, indicating its effect on operations.
- Asset (`asset_id`, text): The primary asset id associated with the service record.
- Ci ID (`ci_id`, number): The main configuration item (CI) id related to the service record.
- Priority (`priority`, number): The priority id level of the service record.
- Status (`status`, number): The current status id of the service record (e.g., Open, Closed, Pending). Depends on an account.
- Title (`title`, text): The title or subject of the service record.
- Urgency (`urgency`, number): The urgency level of the service record, indicating how quickly it should be addressed.
- Weight (`weight`, number): A numerical value that may indicate the relative importance or complexity of the service record.
- Sr sub type (`sr_sub_type`, number): Service record subtype.
- Location (`location`, number): Unique id of the location associated with the service record.
- Cust int1 (`cust_int1`, number): Custom value 1.
- Cust int2 (`cust_int2`, number): Custom value 1.
- Cust date1 (`cust_date1`, date and time): Custom date 1.
- Cust date2 (`cust_date2`, date and time): Custom date 1.
- Cust notes (`cust_notes`, text): Custom notes.
- Cust text1 (`cust_text1`, text): Custom text 1.
- Cust text2 (`cust_text2`, text): Custom text 2.
- Cust list1 (`cust_list1`, number): Custom list 1 integer identifier.
- Cust list2 (`cust_list2`, number): Custom list 1 integer identifier.
- Parent link (`parent_link`, number): Parent link.
- Workaround (`workaround`, text): Workaround.
- Task ID (`task_id`, number): Task ID.
- Project ID (`project_id`, number): Project ID.
- Success rating (`success_rating`, number): Success rating.
- Followup text (`followup_text`, text): Followup text.
- Followup actual date (`followup_actual_date`, date and time): Followup actual date.
- Followup planned date (`followup_planned_date`, date and time): Followup planned date.
- Cc (`cc`, text): Cc.
- Primary category (`primary_category`, number): First level service record category id.
- Secondary category (`secondary_category`, number): Second level service record category id.
- Third level category (`third_level_category`, number): Third level service record category id.
- Assigned group (`assigned_group`, text): Name of the administrative group responsible for managing the service record.
- Assignee (`assignee`, text): Username of the user to whom the service record is assigned.
- Request user (`request_user`, text): Username of the user who originally requested the service record.
- Followup user (`followup_user`, text): Username of the user who follows up the service record's changes.
- Responsible manager (`responsible_manager`, text): Admin username who manages the service record.
- Custom columns fields (`custom_columns_fields`, object): Custom columns fields.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 1779,
    "version": 1
  }
}
```
