Simple python library for interacting with the SysAid REST API. Exposes all the endpoint as methods within the client. Hope to one day create class objects for each data model (SR, Asset, CI, etc).

Current Version: 0.0.5

Have added placeholders for all documented client resources. All SR endpoints are implemented, many more to do. Ultimately the meat of the library will be within the actual objects, right now focusing on the client mostly.

There are some undocumented endpoints out there, one of which is event_logs that I just found out about. If you know of any please let me know or submit a PR adding them.

https://documentation.sysaid.com/docs/rest-api-details

You will need this! Note that the methods for each endpoint are not specified for some reason, I've had to interpret what the endpoint is doing to know which method. For example, retrieving any info is probably a GET request, updating an SR is probably a PUT request, and creating is probably a POST request.

1. Finish implementing all endpoints
2. Add tests
3. Implement SR Object for pythonic access
4. Implement all other objects for pythonic access (expand later)
5. Add field updating to SR Class

Install from github with:

python -m pip install git+https://github.com/Djones4822/pySysAid

Then, in your project import with

from pysysaid import Client

Create a connection by instantiating a client object

un = 'myusername'
pw = 'mypassword'
env_name = 'my_env_name'  # this is provided to you by SysAid once your instance is created
client = Client(username=username, password=password, environment_name=env_name)

Upon instantiation, the client will log in. I don't believe SSO works, so you need to create a SysAid Administrator with mobile access. After logging in, the library will create a file in the current working directory called {username}_cookies.json where the necessary cookies are stored. These get written to a file for easy re-use between runs, as the SysAid API only allows 2 logins per 5 minutes.

Once you have the client you can then use the few helper functions I've added, or issue your own requests:

# Helper Functions:

client.get_sr(id=1)
client.get_sr_list(**kwargs)  # see the sysaid rest api documentation for valid fields
client.search_srs(**kwargs)   # see the sysaid rest api documentation for valid fields
client.update_sr(id=1, field_dict={'sr_status': 'Open'})  # see the sysaid rest api documentation for valid fields

# Or execute your own request
client.make_request('get', 'sr/1')