Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
dctrackclient
Advanced tools
WARNING: this project is still under development and may not be stable!
Sunbird dcTrack API clients in Python and JavaScript
dcTrackClient can be installed from the package manager of your choice.
pip install dcTrackClient
npm i dctrackclient
Authentication is by using a base URL (the same URL to access the GUI) and a username and password, or a base URL and an API token.
from dcTrackClient import Client
## Using a username and password ##
api = Client('https://dctrack.example.com/', username='user', password='pass')
## Using an API token ##
api = Client('https://dctrack.example.com/', apiToken='token')
import * as api from 'dctrackclient';
// Using a username and password //
api.Client.authenticate('https://dctrack.example.com/', { username: 'user', password: 'pass' });
// Using an API token //
api.Client.authenticate('https://dctrack.example.com/', { apiToken: 'token' });
This section is currently under construction.
api.createItem({'cmbLocation': 'SAMPLE LOCATION', 'tiName': 'NEW-ITEM', 'cmbMake': 'Generic', 'cmbModel': 'Generic^Rackable^01'})
item = api.getItem(1234)
Returns:
{
"item": {
... // item attributes in here
}
}
api.modifyItem(1234, {'tiSerialNumber': 'SN-12345', 'tiAssetTag': 'DEV-12345'})
api.deleteItem(1234)
Visit this link for the official documentation on request bodies and attrribute names.
https://www.sunbirddcim.com/help/dcTrack/v900/API/en/Default.htm
Get item details using the item ID.
GET api/v2/dcimoperations/items/{id}
Parameter | Type |
---|---|
id | number |
Create a new item. When returnDetails is set to true, the API call will return the full json payload. If set to false, the call returns only the "id" and "tiName".
POST api/v2/dcimoperations/items payload
Parameter | Type |
---|---|
returnDetails | boolean |
payload | object |
Update an existing item. When returnDetails is set to true, the API call will return the full json payload. If set to false, the call returns only the "id" and "tiName".
PUT api/v2/dcimoperations/items/{id} payload
Parameter | Type |
---|---|
id | number |
returnDetails | boolean |
payload | object |
Delete an item using the item ID.
DELETE api/v2/dcimoperations/items/{id}
Parameter | Type |
---|---|
id | number |
Search for items using criteria JSON object. Search criteria can be any of the fields applicable to items, including custom fields. Specify the fields to be included in the response. This API supports pagination. Returns a list of items with the specified information.
POST api/v2/quicksearch/items payload
Parameter | Type |
---|---|
pageNumber | number |
pageSize | number |
payload | object |
Returns a list of Items contained in a Cabinet using the ItemID of the Cabinet. The returned list includes all of the Cabinet's Items including Passive Items.
GET api/v2/items/cabinetItems/{CabinetId}
Parameter | Type |
---|---|
CabinetId | number |
Add/Update/Delete Items.
POST api/v2/dcimoperations/items/bulk payload
Parameter | Type |
---|---|
payload | object |
Returns a list of makes with basic information.
GET api/v2/makes
No parameters.
Add a new Make. Returns JSON entity containing Make information that was passed in from the Request payload.
POST api/v2/makes payload
Parameter | Type |
---|---|
payload | object |
Modify a Make. Returns JSON entity containing Make information that was passed in from the Request payload.
PUT api/v2/makes/{makeId} payload
Parameter | Type |
---|---|
makeId | number |
payload | object |
Delete a Make.
DELETE api/v2/makes/{makeId}
Parameter | Type |
---|---|
makeId | number |
Search for a make using the make name. Returns a list of makes with basic information.
GET api/v2/dcimoperations/search/makes/{makeName}
Parameter | Type |
---|---|
makeName | string |
Get Model fields for the specified Model ID. usedCounts is an optional parameter that determines if the count of Items for the specified model is returned in the response. If set to "true" the counts will be included in the response, if omitted or set to "false" the item count will not be included in the response.
GET api/v2/models/{modelId}
Parameter | Type |
---|---|
modelId | number |
usedCounts | number |
Add a new Model. Returns JSON entity containing Make information that was passed in from the Request payload. "proceedOnWarning" relates to the warning messages that are thrown in dcTrack when you try to delete custom fields that are in use. The "proceedOnWarning" value can equal either "true" or "false." If "proceedOnWarning" equals "true," business warnings will be ignored. If "proceedOnWarning" equals "false," business warnings will not be ignored. Fields that are not in the payload will remain unchanged.
POST api/v2/models payload
Parameter | Type |
---|---|
returnDetails | boolean |
proceedOnWarning | boolean |
payload | object |
Delete a Model using the Model ID.
DELETE api/v2/models/{id}
Parameter | Type |
---|---|
id | number |
Search for models by user supplied search criteria. Returns a list of models with the "selectedColumns" returned in the payload. Search by Alias is not supported.
POST api/v2/quicksearch/models payload
Parameter | Type |
---|---|
pageNumber | number |
pageSize | number |
payload | object |
Delete a Mode Image using the Model ID and the Image Orientation, where id is the Model Id and orientation is either front or back
DELETE api/v2/models/images/{id}/{orientation}
Parameter | Type |
---|---|
id | number |
orientation | string |
Get a Connector record by ID. Returns a Connector with all information including Compatible Connectors. The usedCount parameter is optional. If usedCount is true, the response will include the number of times the connector is in use by Models and Items. If false, no counts are returned. If omitted the default is false.
GET api/v2/settings/connectors/{connectorId}
Parameter | Type |
---|---|
connectorId | number |
usedCount | boolean |
Add a new Connector. Returns JSON entity containing Connector information that was passed in from the Request payload.
POST api/v2/settings/connectors payload
Parameter | Type |
---|---|
payload | object |
Update an existing Connector. Returns JSON entity containing Connector information that was passed in from the Request payload.
PUT api/v2/settings/connectors/{connectorId} payload
Parameter | Type |
---|---|
connectorId | number |
payload | object |
Delete one or more Connector records.
POST api/v2/settings/connectors/delete payload
Parameter | Type |
---|---|
payload | object |
Retrieve a List of Connectors. Returns JSON entity containing Connector information that was passed in from the Request payload. Please note, Compatible Connectors are not returned by this API, but can be returned when querying a single Connector using the /api/v2/settings/connectors/{connectorId} API.
POST api/v2/settings/connectors/quicksearch payload
Parameter | Type |
---|---|
pageNumber | number |
pageSize | number |
usedCount | boolean |
payload | object |
Delete a Connector Image using the Connector ID.
DELETE api/v2/settings/connectors/{connectorId}/images
Parameter | Type |
---|---|
connectorId | number |
FAQs
Sunbird dcTrack API client in JavaScript
The npm package dctrackclient receives a total of 2 weekly downloads. As such, dctrackclient popularity was classified as not popular.
We found that dctrackclient demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.