Skip to main content

Python SNC (REST) API

Project description

ServiceNow Python API

What: PySnc is a python interface for the ServiceNow and the Table API. It is designed to mimic the familiar GlideRecord interface you know with pythonic support where applicable.

Why: Spawned from the desire to interact with ServiceNow data in a familiar and consistent manner

Install

pip install pysnc

Quick Start

from pysnc import ServiceNowClient

client = ServiceNowClient('https://dev0000.service-now.com', ('integration.user', password))

gr = client.GlideRecord('sys_user')
gr.add_query('user_name', 'admin')
gr.query()
for r in gr:
	print(r.sys_id)

Or you can more traditionally:

while gr.next():
	print(gr.sys_id);

It is recommended you use OAuth, however:

from pysnc import ServiceNowClient, ServiceNowOAuth2

client = ServiceNowClient('dev0000', ServiceNowOAuth2('integration.user', password))

Documentation

Full documentation currently available at https://servicenow.github.io/PySNC/

Or build them yourself:

cd docs && make html

Development Notes

The following functions are not (yet?) supported:

  • choose_window(first_row, last_row, force_count=True) TODO
  • get_class_display_value()
  • get_record_class_name()
  • get_unique_value()
  • is_valid() TODO
  • is_valid_record()
  • new_record()
  • update_multiple() TODO
  • _next()
  • _query()

The following will not be implemented:

  • get_attribute(field_name) Not Applicable
  • get_ED() Not Applicable
  • get_label() Not Applicable
  • get_last_error_message() Not Applicable
  • set_workflow(enable) Not Possible
  • operation() Not Applicable
  • set_abort_action() Not Applicable
  • is_valid_field() Not Possible
  • is_action_aborted() Not Applicable

Further Reading

See the documentation.

Feature Wants and TODO

  • GlideAggregate support (/api/now/stats/{tableName})

And we want to:

  • Improve documentation
  • Refactor session abstraction
  • Improve Attachment OO

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysnc-1.0.7.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

pysnc-1.0.7-py2.py3-none-any.whl (18.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pysnc-1.0.7.tar.gz.

File metadata

  • Download URL: pysnc-1.0.7.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for pysnc-1.0.7.tar.gz
Algorithm Hash digest
SHA256 c251f557109269af45fcefdaa12cd248cc7927a51be9c65151100568b11a0b5b
MD5 dd640ed1db8d97cfcd1cc38309edfada
BLAKE2b-256 cc55e4f3814d0a056556ee9831d753d95eba257354e68e8fe5914479ee1e09a3

See more details on using hashes here.

File details

Details for the file pysnc-1.0.7-py2.py3-none-any.whl.

File metadata

  • Download URL: pysnc-1.0.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for pysnc-1.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 403330043e52a8edf4ee7b5847ca00a917131b4928d403bedcf42d12a4405d37
MD5 2e7077077db9336d7a5b0c43cc7ebdfd
BLAKE2b-256 7c53d8f14753d83d862b4e696483f3456279b67de908a11d561ccff480ad2ac9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page