rtc-client

1.0.16 • Public • Published

rtc-client Build Status Coverage Status

Nodejs client for the RTC(Rational Team Concert) Reportable REST API.

Install

$ npm install --save rtc-client

Usage

Init RTC Client

const RTCClient = require('rtc-client');
 
const rtc = new RTCClient({
    server: 'localhost',
    username: 'username',
    password: 'password'
});
await rtc.login();

Get workitems using filters

const workItens = await rtc.getWorkItems({
    filters: {
        'type/id': 'task',
        'id': 123
    }
})

Get workitems specifying fields

const workItens = rtc.getWorkItems({
    fields: ['id', 'summary'],
    filters: {
        'type/id': 'task',
        'id': 123
    }
})

Get Contributors using filters

const contributors = await rtc.getContributors({
    filters: {
        'itemId': '123'
    }
})

Constructor options

server: RTC server address. Default value is 'localhost'.

username: user name for login.

password: password for login.

protocol: default value is 'https'.

acceptUntrustedCertificates: accept auto-assigned certificates: INSECURE. Default value is false.

explicitArray: on xml2json conversion, always put child nodes in an array if true; otherwise an array is created only if there is more than one. Default is true.

License

MIT © Danilo Sampaio

Package Sidebar

Install

npm i rtc-client

Weekly Downloads

4

Version

1.0.16

License

MIT

Unpacked Size

46.7 kB

Total Files

12

Last publish

Collaborators

  • danilosampaio