SysAid
App · 20 actions
Manage SysAid service records, companies and assets, look up staff, and watch new or changed records.
Actions
| Action | What it does |
|---|---|
| Create asset | Create asset. |
| Create company | Create company. |
| Create service record | Create service record. |
| Delete asset | Delete asset. |
| Delete company | Delete company. |
| Delete service record | Delete service record. |
| Get agent | Get agent. |
| Get asset | Get asset. |
| Get company | Get company. |
| Get end user | Get end user. |
| Get service record | Get service record. |
| List agents | List agents. |
| List assets | List assets. |
| List companies | List companies. |
| List end users | List end users. |
| List groups | List groups. |
| List service records | List service records. |
| Update asset | Update asset. |
| Update company | Update company. |
| Update service record | Update service record. |
Create asset
Create asset.
Inputs
- Name
nametextRequired - The name of the asset.
- Type
typetextRequired - The asset type (Laptop / Smartphone / etc.).
- Source
sourcetext - The origin of the asset, describing how it was added to the system.
- Manufacturer
manufacturertext - The manufacturer of the asset.
- Model
modeltext - The model of the asset.
- Serial
serialtext - The asset's serial number according to the manufacturer.
- Description
descriptiontext - The description of the asset.
- Is disabled
is_disabledtrue/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_idnumber - The unique ID of the user who owns the asset.
- Ownership
ownershiptext - Defines who is the official owner of the asset - the employee or the company.One of:
personal,company. - Company
company_idnumber - The unique ID of the company the asset belongs to.
- Location ID
location_idnumber - The unique ID of the asset’s location.
- Department ID
department_idnumber - The unique ID of the department the asset belongs to.
- Warranty expiration
warranty_expirationdate - The date when the asset’s warranty expires.
- Patch management enabled
patch_management_enabledtrue/false - Indicates if patch management is enabled for the asset. To learn more, see SysAid Patch Management Guide.
- Os
osobject - Operating System properties.
- Network
networkobject - Network properties.
- Custom fields
custom_fieldsobject - Custom fields.
- Additional data
additional_datatext - Additional data available for the asset.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": "MSI-123",
"success": true
}
}Create company
Create company.
Inputs
- Name
nametextRequired - Name.
- Address
addresstext - Main company address.
- Address2
address2text - Additional company address.
- City
citytext - The city in which the company is located.
- State
statetext - The state in which the company is located.
- Zip
ziptext - The company's zip code.
- Country
countrytext - The country in which the company is located.
- Phone
phonetext - The company’s phone number.
- Fax
faxtext - The company’s fax number.
- Notes
notestext - Notes related to the company.
- Email account
email_accounttext - Default email account.
- Expiration date
expiration_datedate - The date when the company's access to the help will expire.
- Agreement ID
agreement_idnumber - The ID of the SLA applied to the company.
- Agreement start date
agreement_start_datedate - The start date of your service agreement with the company.
- Agreement end date
agreement_end_datedate - The end date of your service agreement with the company.
- Custom fields
custom_fieldsobject - Company custom fields.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 100
}
}Create service record
Create service record.
Inputs
- Template ID
template_idnumber - Template ID.
- Type
typetextRequired - Type.One of:
incident,problem,request,change. - Change category
change_categorynumber - The classification or severity level id of the service record (relevant only for service requests of Change type and depends on the account).
- Description
descriptiontext - A detailed description of the service record.
- Due date
due_datedate and time - The date by which the service record is expected to be resolved.
- Impact
impactnumber - The impact level of the service record, indicating its effect on operations.
- Asset
asset_idtext - The primary asset id associated with the service record.
- Ci ID
ci_idnumber - The main configuration item (CI) id related to the service record.
- Priority
prioritynumber - The priority id level of the service record.
- Status
statusnumber - The current status id of the service record (e.g., Open, Closed, Pending). Depends on an account.
- Title
titletextRequired - The title or subject of the service record.
- Urgency
urgencynumber - The urgency level of the service record, indicating how quickly it should be addressed.
- Weight
weightnumber - A numerical value that may indicate the relative importance or complexity of the service record.
- Sr sub type
sr_sub_typenumber - Service record subtype.
- Location
locationnumber - Unique id of the location associated with the service record.
- Cust int1
cust_int1number - Custom value 1.
- Cust int2
cust_int2number - Custom value 1.
- Cust date1
cust_date1date and time - Custom date 1.
- Cust date2
cust_date2date and time - Custom date 1.
- Cust notes
cust_notestext - Custom notes.
- Cust text1
cust_text1text - Custom text 1.
- Cust text2
cust_text2text - Custom text 2.
- Cust list1
cust_list1number - Custom list 1 integer identifier.
- Cust list2
cust_list2number - Custom list 1 integer identifier.
- Parent link
parent_linknumber - Parent link.
- Workaround
workaroundtext - Workaround.
- Task ID
task_idnumber - Task ID.
- Project ID
project_idnumber - Project ID.
- Version
versionnumber - Version.
- Success rating
success_ratingnumber - Success rating.
- Followup text
followup_texttext - Followup text.
- Followup actual date
followup_actual_datedate and time - Followup actual date.
- Followup planned date
followup_planned_datedate and time - Followup planned date.
- Cc
cctext - Cc.
- Primary category
primary_categorynumber - First level service record category id.
- Secondary category
secondary_categorynumber - Second level service record category id.
- Third level category
third_level_categorynumber - Third level service record category id.
- Assigned group
assigned_grouptext - Name of the administrative group responsible for managing the service record.
- Assignee
assigneetext - Username of the user to whom the service record is assigned.
- Request user
request_usertext - Username of the user who originally requested the service record.
- Followup user
followup_usertext - Username of the user who follows up the service record's changes.
- Responsible manager
responsible_managertext - Admin username who manages the service record.
- Custom columns fields
custom_columns_fieldsobject - Custom columns fields.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 1779,
"version": 1
}
}Delete asset
Delete asset.
Inputs
- Id
idtextRequired - The unique identifier of the asset in SysAid.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Delete company
Delete company.
Inputs
- Company
company_idnumberRequired - The unique identifier of the company in SysAid.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Delete service record
Delete service record.
Inputs
- Record
record_idnumberRequired - The service record's unique SysAid ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Get agent
Get agent.
Inputs
- Id
idnumberRequired - The agent's unique SysAid ID.
- Expand
expandlist - Include additional related data in the response for the selected entity/entities.One or more of:
groups,company.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 342,
"version": 13
}
}Get asset
Get asset.
Inputs
- Id
idtextRequired - The unique identifier of the asset in SysAid.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": "MSI-123",
"name": "KATANA-GF66",
"version": 1
}
}Get company
Get company.
Inputs
- Company
company_idnumberRequired - The unique identifier of the company in SysAid.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 1,
"name": "Alpha",
"version": 5
}
}Get end user
Get end user.
Inputs
- Id
idnumberRequired - The end user's unique SysAid ID.
- Expand
expandlist - Include additional related data in the response for the selected entity/entities.One or more of:
groups,company.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 342,
"version": 13
}
}Get service record
Get service record.
Inputs
- Record
record_idnumberRequired - The unique ID of the service record
- Fields
fieldslist - A comma-separated list of service record fields to return in response.
- Expand
expandlist - Names of service record property to expandOne or more of:
company,requestUser,ci,asset,category.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 1779,
"version": 1
}
}List agents
List agents.
Inputs
- Limit
limitnumber - The numbder of items to display per page. The deafult is 20 and you can have up to 500.From 1 to 500.
- Offset
offsetnumber - The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
- Query
querytext - Query to search by username, first name, last name, email or phone.
- Expand
expandlist - Include additional related data in the response for the selected entity/entities.One or more of:
groups,company.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}List assets
List assets.
Inputs
- Limit
limitnumber - The number of records to return per page, up to 500.From 1 to 500.
- Offset
offsetnumber - The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
- Sort by
sort_bytext - An asset field to sort by.One of:
id,name,type,manufacturer,model,serial,ownerId,source,ownership,companyId, and 4 more. - Sort dir
sort_dirtext - Assets sorting direction.One of:
asc,desc. - Query
querytext - A string by which assets are searched. The search is made in the following asset properties: name, description and additionalData.
- Id
idlist - Assets id filter.
- Source
sourcelist - Assets source filter.
- Ownership
ownershiplist - Assets ownership filterOne or more of:
personal,company,none. - Is disabled
is_disabledtrue/false - Assets disablement status filter.
- Owner ID
owner_idlist - Assets owner ids filter.
- Name
nametext - Assets name filter.
- Type
typetext - Assets type filter.
- Description
descriptiontext - Assets description filter.
- Ip addresses
ip_addressestext - Assets IP addresses filter.
- Mac addresses
mac_addressestext - Assets MAC addresses filter
- Manufacturer
manufacturertext - Assets manufacturer name filter.
- Model
modeltext - Assets model name filter.
- Serial
serialtext - Assets model name filter.
- Company
company_idlist - Assets company id filter.
- Department ID
department_idlist - Assets department id filter.
- Location ID
location_idlist - Assets location id filter.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}List companies
List companies.
Inputs
- Limit
limitnumber - The number of items to display per page. The default is 100, and you can have up to 500.From 1 to 500.
- Offset
offsetnumber - The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
- Query
querytext - The string by which to search companies.
- Name
nametext - The name (partial or whole) companies filter.
- Id
idlist - The ID companies filter.
- State
statetext - The state (partial or whole) companies filter.
- City
citytext - The city (partial or whole) companies filter.
- Country
countrytext - The country (partial or whole) companies filter.
- Address
addresstext - The address (partial or whole) companies filter.
- Agreement ID
agreement_idlist - The agreement ID companies filter.
- Sort by
sort_bytext - 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_dirtext - The direction in which companies are sorted.One of:
asc,desc.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}List end users
List end users.
Inputs
- Limit
limitnumber - The numbder of items to display per page. The deafult is 20 and you can have up to 500.From 1 to 500.
- Offset
offsetnumber - The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
- Query
querytext - Query to search by username, first name, last name, email or phone.
- Expand
expandlist - Include additional related data in the response for the selected entity/entities.One or more of:
groups,company.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}List groups
List groups.
Inputs
- Limit
limitnumber - The numbder of items to display per page. The deafult is 20 and you can have up to 500.From 1 to 500.
- Offset
offsetnumber - The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}List service records
List service records.
Inputs
- Fields
fieldslist - A comma-separated list of fields to return in service records.
- Query
querytext - The search criteria
- Offset
offsetnumber - 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
limitnumber - The maximum number of SRs to retrieve per request. Defaults to 100 results (configurable).At most 100.
- Sort by
sort_bylist - One or more fields to sort by. Available fields are those that were fetched by the request.
- Sort dir
sort_dirtext - Sort order: ascending or descending. Available values: asc/desc. Default is 'asc'. Relevant only when sort parameter is sent.One of:
asc,desc. - Expand
expandlist - Names of service record property to expandOne or more of:
company,requestUser,ci,asset,category. - Filters
filtersobject - 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
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}Update asset
Update asset.
Inputs
- Id
idtextRequired - The unique identifier of the asset in SysAid.
- Name
nametext - The name of the asset.
- Type
typetext - The asset type (Laptop / Smartphone / etc.).
- Source
sourcetext - The origin of the asset, describing how it was added to the system.
- Manufacturer
manufacturertext - The manufacturer of the asset.
- Model
modeltext - The model of the asset.
- Serial
serialtext - The asset's serial number according to the manufacturer.
- Description
descriptiontext - The description of the asset.
- Is disabled
is_disabledtrue/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_idnumber - The unique ID of the user who owns the asset.
- Ownership
ownershiptext - Defines who is the official owner of the asset - the employee or the company.One of:
personal,company. - Company
company_idnumber - The unique ID of the company the asset belongs to.
- Location ID
location_idnumber - The unique ID of the asset’s location.
- Department ID
department_idnumber - The unique ID of the department the asset belongs to.
- Warranty expiration
warranty_expirationdate - The date when the asset’s warranty expires.
- Patch management enabled
patch_management_enabledtrue/false - Indicates if patch management is enabled for the asset. To learn more, see SysAid Patch Management Guide.
- Os
osobject - Operating System properties.
- Network
networkobject - Network properties.
- Custom fields
custom_fieldsobject - Custom fields.
- Additional data
additional_datatext - Additional data available for the asset.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"success": true
}
}Update company
Update company.
Inputs
- Company
company_idnumberRequired - The unique identifier of the company in SysAid.
- Name
nametext - Name.
- Address
addresstext - Main company address.
- Address2
address2text - Additional company address.
- City
citytext - The city in which the company is located.
- State
statetext - The state in which the company is located.
- Zip
ziptext - The company's zip code.
- Country
countrytext - The country in which the company is located.
- Phone
phonetext - The company’s phone number.
- Fax
faxtext - The company’s fax number.
- Notes
notestext - Notes related to the company.
- Email account
email_accounttext - Default email account.
- Expiration date
expiration_datedate - The date when the company's access to the help will expire.
- Agreement ID
agreement_idnumber - The ID of the SLA applied to the company.
- Agreement start date
agreement_start_datedate - The start date of your service agreement with the company.
- Agreement end date
agreement_end_datedate - The end date of your service agreement with the company.
- Custom fields
custom_fieldsobject - Company custom fields.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 1,
"name": "Alpha",
"version": 5
}
}Update service record
Update service record.
Inputs
- Record
record_idnumberRequired - The service record's unique SysAid ID.
- Change category
change_categorynumber - The classification or severity level id of the service record (relevant only for service requests of Change type and depends on the account).
- Description
descriptiontext - A detailed description of the service record.
- Due date
due_datedate and time - The date by which the service record is expected to be resolved.
- Impact
impactnumber - The impact level of the service record, indicating its effect on operations.
- Asset
asset_idtext - The primary asset id associated with the service record.
- Ci ID
ci_idnumber - The main configuration item (CI) id related to the service record.
- Priority
prioritynumber - The priority id level of the service record.
- Status
statusnumber - The current status id of the service record (e.g., Open, Closed, Pending). Depends on an account.
- Title
titletext - The title or subject of the service record.
- Urgency
urgencynumber - The urgency level of the service record, indicating how quickly it should be addressed.
- Weight
weightnumber - A numerical value that may indicate the relative importance or complexity of the service record.
- Sr sub type
sr_sub_typenumber - Service record subtype.
- Location
locationnumber - Unique id of the location associated with the service record.
- Cust int1
cust_int1number - Custom value 1.
- Cust int2
cust_int2number - Custom value 1.
- Cust date1
cust_date1date and time - Custom date 1.
- Cust date2
cust_date2date and time - Custom date 1.
- Cust notes
cust_notestext - Custom notes.
- Cust text1
cust_text1text - Custom text 1.
- Cust text2
cust_text2text - Custom text 2.
- Cust list1
cust_list1number - Custom list 1 integer identifier.
- Cust list2
cust_list2number - Custom list 1 integer identifier.
- Parent link
parent_linknumber - Parent link.
- Workaround
workaroundtext - Workaround.
- Task ID
task_idnumber - Task ID.
- Project ID
project_idnumber - Project ID.
- Success rating
success_ratingnumber - Success rating.
- Followup text
followup_texttext - Followup text.
- Followup actual date
followup_actual_datedate and time - Followup actual date.
- Followup planned date
followup_planned_datedate and time - Followup planned date.
- Cc
cctext - Cc.
- Primary category
primary_categorynumber - First level service record category id.
- Secondary category
secondary_categorynumber - Second level service record category id.
- Third level category
third_level_categorynumber - Third level service record category id.
- Assigned group
assigned_grouptext - Name of the administrative group responsible for managing the service record.
- Assignee
assigneetext - Username of the user to whom the service record is assigned.
- Request user
request_usertext - Username of the user who originally requested the service record.
- Followup user
followup_usertext - Username of the user who follows up the service record's changes.
- Responsible manager
responsible_managertext - Admin username who manages the service record.
- Custom columns fields
custom_columns_fieldsobject - Custom columns fields.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": 1779,
"version": 1
}
}