Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cityssm/node-worktech-api

Integrations with the WorkTech work order management system.
https://github.com/cityssm/node-worktech-api

work-manager work-orders worktech

Last synced: about 2 months ago
JSON representation

Integrations with the WorkTech work order management system.

Host: GitHub
URL: https://github.com/cityssm/node-worktech-api
Owner: cityssm
License: mit
Created: 2024-03-20T18:15:52.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-10-14T23:06:03.000Z (3 months ago)
Last Synced: 2024-11-08T12:06:25.504Z (3 months ago)
Topics: work-manager, work-orders, worktech
Language: TypeScript
Homepage: https://www.npmjs.com/package/@cityssm/worktech-api
Size: 402 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Unofficial WorkTech API for Node

[![DeepSource](https://app.deepsource.com/gh/cityssm/node-worktech-api.svg/?label=active+issues&show_trend=true&token=dXtpnezfJ8MzuRxb95LrmLA_)](https://app.deepsource.com/gh/cityssm/node-worktech-api/)

[![Maintainability](https://api.codeclimate.com/v1/badges/92c881705b023008cde1/maintainability)](https://codeclimate.com/github/cityssm/node-worktech-api/maintainability)

This package assists with integrations between WorkTech and other systems.

It is not meant to be a complete API, and it is not endorsed by WorkTech.

The queries used were discovered using tools like SQL Profiler,

and are subject to change and break with WorkTech application updates.

Before using this package, especially for update purposes,

be sure to run the queries against a test system!

## Sample Functions

- `getEquipmentByEquipmentId(equipmentId: string): Promise;`

- `getItemByItemId(itemId: string): Promise;`

- `getWorkOrderByWorkOrderNumber(workOrderNumber: string): Promise;`

- `getWorkOrderResourcesByWorkOrderNumber(workOrderNumber: string): Promise;`

- `getWorkOrderResourcesByStartDate(startDateString: DateString): Promise;`

- `getJobByJobId(jobId: string): Promise;`

- `getActivityByActivityId(activityId: string): Promise;`

- `getObjectCodeByObjectCode(objectCode: string): Promise;`

For a complete list,

see [`index.ts`](https://github.com/cityssm/node-worktech-api/blob/main/index.ts).

## Sample Update Functions

- `addWorkOrderResource(workOrderResource: AddWorkOrderResource): Promise;`

- `updateWorkOrderResource(workOrderResource: WorkOrderResource): Promise;`

- `deleteWorkOrderResource(workOrderResourceId: BigIntString): Promise;`

## Other Related Projects

[FASTER Web Report Parser](https://github.com/cityssm/node-faster-report-parser)


Parses select Excel and CSV reports from FASTER Web into usable data objects.