Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
REST API of the SYSNET managed dictionaries (code lists) system. Primarily designed for the CITES Registry.
This Python package is automatically generated by the Swagger Codegen project:
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import dict
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import dict
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import dict
from dict.rest import ApiException
from pprint import pprint
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
dictionary = 'dictionary_example' # str | Dictionary identifier
key = 'key_example' # str | Descriptor key or alternate key
active = True # bool | activate/deactivate descriptor
try:
# activates/deactivates the descriptor by key
api_response = api_instance.activate_descriptor(dictionary, key, active)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->activate_descriptor: %s\n" % e)
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
dictionary = 'dictionary_example' # str | Dictionary identifier
body = dict.Descriptor() # Descriptor | Descriptor to add (optional)
try:
# adds an descriptor
api_instance.add_descriptor(dictionary, body=body)
except ApiException as e:
print("Exception when calling AdminsApi->add_descriptor: %s\n" % e)
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
dictionary = 'dictionary_example' # str | Dictionary identifier
key = 'key_example' # str | Descriptor key or alternate key
try:
# removes a descriptor
api_response = api_instance.delete_descriptor(dictionary, key)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->delete_descriptor: %s\n" % e)
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
try:
# exports all descriptors from the system
api_response = api_instance.export_all()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->export_all: %s\n" % e)
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
dictionary = 'dictionary_example' # str | Dictionary identifier
try:
# exports all descriptors from specifies dictionary
api_response = api_instance.export_dictionary(dictionary)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->export_dictionary: %s\n" % e)
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
body = [dict.Descriptor()] # list[Descriptor] | Array of descriptors to import (optional)
replace = True # bool | replaces whole database (optional)
try:
# imports descriptors of several directories
api_response = api_instance.import_descriptors(body=body, replace=replace)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->import_descriptors: %s\n" % e)
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
dictionary = 'dictionary_example' # str | Dictionary identifier
body = [dict.Descriptor()] # list[Descriptor] | Array of descriptors to import (optional)
replace = True # bool | replaces existing dictionary (optional)
try:
# imports a dictionary
api_response = api_instance.import_dictionary(dictionary, body=body, replace=replace)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->import_dictionary: %s\n" % e)
# Configure API key authorization: apiKey
configuration = dict.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = dict.AdminsApi(dict.ApiClient(configuration))
dictionary = 'dictionary_example' # str | Dictionary identifier
key = 'key_example' # str | Descriptor key or alternate key
body = dict.Descriptor() # Descriptor | Descriptor to replace (optional)
try:
# replaces a descriptor
api_response = api_instance.put_descriptor(dictionary, key, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->put_descriptor: %s\n" % e)
All URIs are relative to https://virtserver.swaggerhub.com/SYSNET/dictionary/1.0.0
Class | Method | HTTP request | Description |
---|---|---|---|
AdminsApi | activate_descriptor | GET /{dictionary}/{key}/activate | activates/deactivates the descriptor by key |
AdminsApi | add_descriptor | POST /{dictionary} | adds an descriptor |
AdminsApi | delete_descriptor | DELETE /{dictionary}/{key} | removes a descriptor |
AdminsApi | export_all | GET /export | exports all descriptors from the system |
AdminsApi | export_dictionary | GET /{dictionary}/export | exports all descriptors from specifies dictionary |
AdminsApi | import_descriptors | POST /import | imports descriptors of several directories |
AdminsApi | import_dictionary | POST /{dictionary}/import | imports a dictionary |
AdminsApi | put_descriptor | PUT /{dictionary}/{key} | replaces a descriptor |
DevelopersApi | info_api | GET /info | gets service info |
PublicApi | get_descriptor | GET /{dictionary}/{key} | gets a descriptor by key |
PublicApi | search_dictionary | GET /{dictionary} | searches dictionary (autocomplete) |
FAQs
REST API of the SYSNET managed dictionaries (code lists) system.
We found that sysnet-dict demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.