Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

dctrackclient

Package Overview
Dependencies
Maintainers
1
Versions
37
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

dctrackclient

Sunbird dcTrack API client in JavaScript

  • 0.4.3
  • unpublished
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

WARNING: this project is still under development and may not be stable!

dcTrackClient GitHub Workflow Status PyPI PyPI - Downloads npm npm

Sunbird dcTrack API clients in Python and JavaScript

Initialize a connection to the dcTrack API

Import the class:

from dcTrackClient import Client

Authenticate using a base URL (the same URL to access the GUI) and a username and password:

api = Client('https://dctrack.example.com/', username='user', password='pass')

Authenticate using a base URL and an API token:

api = Client('https://dctrack.example.com/', apiToken='asdf')

Usage Example

Create an item:

  • This example shows the minimum attributes required to create an item
  • See the official documentation for a comprehensive list of attributes
  • This function returns the JSON object for the newly created item
  • If it fails, the function will return a JSON object containing the error message
api.createItem({'cmbLocation': 'SAMPLE LOCATION', 'tiName': 'NEW-ITEM', 'cmbMake': 'Generic', 'cmbModel': 'Generic^Rackable^01'})

Retrieve item details:

item = api.getItem(1234)

Returns:

{
    "item": {
        ... // item attributes in here
    }
}

Modify an existing item:

api.modifyItem(1234, {'tiSerialNumber': 'SN-12345', 'tiAssetTag': 'DEV-12345'})

Delete an existing item:

api.deleteItem(1234)

Official DcTrack Documentation

Visit this link for the official documentation on request bodies and attrribute names.

https://www.sunbirddcim.com/help/dcTrack/v900/API/en/Default.htm

getItem(id)

Get item details using the item ID.

GET api/v2/dcimoperations/items/{id}
ParameterType
idnumber

createItem(returnDetails, payload)

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
ParameterType
returnDetailsboolean
payloadobject

updateItem(id, returnDetails, payload)

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
ParameterType
idnumber
returnDetailsboolean
payloadobject

deleteItem(id)

Delete an item using the item ID.

DELETE api/v2/dcimoperations/items/{id}
ParameterType
idnumber

searchItems(pageNumber, pageSize, payload)

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
ParameterType
pageNumbernumber
pageSizenumber
payloadobject

cabinetItems(CabinetId)

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}
ParameterType
CabinetIdnumber

manageItemsBulk(payload)

Add/Update/Delete Items.

POST api/v2/dcimoperations/items/bulk payload
ParameterType
payloadobject

getMakes()

Returns a list of makes with basic information.

GET api/v2/makes

No parameters.

createMake(payload)

Add a new Make. Returns JSON entity containing Make information that was passed in from the Request payload.

POST api/v2/makes payload
ParameterType
payloadobject

updateMake(makeId, payload)

Modify a Make. Returns JSON entity containing Make information that was passed in from the Request payload.

PUT api/v2/makes/{makeId} payload
ParameterType
makeIdnumber
payloadobject

deleteMake(makeId)

Delete a Make.

DELETE api/v2/makes/{makeId}
ParameterType
makeIdnumber

searchMakes(makeName)

Search for a make using the make name. Returns a list of makes with basic information.

GET api/v2/dcimoperations/search/makes/{makeName}
ParameterType
makeNamestring

getModel(modelId, usedCounts)

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}
ParameterType
modelIdnumber
usedCountsnumber

createModel(returnDetails, proceedOnWarning, payload)

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
ParameterType
returnDetailsboolean
proceedOnWarningboolean
payloadobject

deleteModel(id)

Delete a Model using the Model ID.

DELETE api/v2/models/{id}
ParameterType
idnumber

searchModels(pageNumber, pageSize, payload)

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
ParameterType
pageNumbernumber
pageSizenumber
payloadobject

deleteModelImage(id, orientation)

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}
ParameterType
idnumber
orientationstring

getConnector(connectorId, usedCount)

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}
ParameterType
connectorIdnumber
usedCountboolean

createConnector(payload)

Add a new Connector. Returns JSON entity containing Connector information that was passed in from the Request payload.

POST api/v2/settings/connectors payload
ParameterType
payloadobject

updateConnector(connectorId, payload)

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
ParameterType
connectorIdnumber
payloadobject

deleteConnector(payload)

Delete one or more Connector records.

POST api/v2/settings/connectors/delete payload
ParameterType
payloadobject

searchConnectors(pageNumber, pageSize, usedCount, payload)

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
ParameterType
pageNumbernumber
pageSizenumber
usedCountboolean
payloadobject

deleteConnectorImage(connectorId)

Delete a Connector Image using the Connector ID.

DELETE api/v2/settings/connectors/{connectorId}/images
ParameterType
connectorIdnumber

Keywords

FAQs

Package last updated on 17 May 2023

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc